Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links to tutorials in rst docs. #2572

Merged
merged 1 commit into from
Jan 12, 2022
+18 −8
Merged

Links to tutorials in rst docs. #2572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions Docs/sphinx_documentation/source/Basics.rst
View file
Open in desktop
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
View file
Open in desktop
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/