Skip to content

Commit

Permalink
Add links to tutorials in Getting Started. In basics, change
Browse files Browse the repository at this point in the history
tutorials to example codes. Remove dead HeatEq link pointer.
  • Loading branch information
etpalmer63 committed Jan 12, 2022
1 parent 9373709 commit 6af0f68
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
10 changes: 4 additions & 6 deletions Docs/sphinx_documentation/source/Basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2685,13 +2685,11 @@ want AMReX to handle this, ``ParmParse`` parameter



.. _sec:basics:heat1:
Example Codes
=============

Tutorials
=========

To assist users we have multiple tutorials introducing AMReX functionality.
To assist users we have multiple example codes introducing AMReX functionality.
They range from HelloWorld walk-thrus to stand-alone examples of complex
features in practice. To access the available tutorials, please see
features in practice. To access the available examples, please see
`AMReX Guided Tutorials and Example Codes
<https://amrex-codes.github.io/amrex/tutorials_html/>`_.
16 changes: 14 additions & 2 deletions Docs/sphinx_documentation/source/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,10 +188,12 @@ and then taking the divergence to update the cells,
+ \frac{\Delta t}{\Delta x}\left(F_{i+^1\!/_2,\,j}-F_{i-^1\!/_2,\,j}\right)
+ \frac{\Delta t}{\Delta y}\left(F_{i,\,j+^1\!/_2}-F_{i,\,j-^1\!/_2}\right)
The implementation details of the code are discussed in section
:ref:`sec:basics:heat1`. For now let's just build and run the code, and
The implementation details of the code are discussed in the `Heat Equation`_ example
section of the Guided Tutorials. For now let's just build and run the code, and
visualize the results.

.. _`Heat Equation`: https://amrex-codes.github.io/amrex/tutorials_html/HeatEquation_EX1_C.html#guided-heat

Building and Running the Code
-----------------------------

Expand Down Expand Up @@ -225,3 +227,13 @@ Profiling Tools` chapter for further details.) Plotfiles can also be viewed
using the VisIt, ParaView, and yt packages. Particle data can be viewed using
ParaView. Refer to Chapter on :ref:`Chap:Visualization` for how to use each of
these tools.

Guided Tutorials
================

Users new to AMReX may be interested in following the `Guided Tutorials`_.
The Guided Tutorials are designed to provide an introduction to AMReX
features by focusing on key concepts in a progressive way.

.. _`Guided Tutorials`: https://amrex-codes.github.io/amrex/tutorials_html/

0 comments on commit 6af0f68

Please sign in to comment.