Skip to content

Commit

Permalink
Changes from round of JOSS review:
Browse files Browse the repository at this point in the history
- Add discussion of sanity checks to getting started
- Make build/bin more consistent in documentation
- Add comment about python path
- Make sure figures display in all browsers by making png versions
  • Loading branch information
jonahm-LANL committed Oct 30, 2024
1 parent 47e0076 commit 0066727
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 7 deletions.
Binary file added doc/sphinx/ApproxForTH.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sphinx/GibbsOrder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sphinx/PMGvsMGUsupPress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sphinx/SteinbergGammarho.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 22 additions & 3 deletions doc/sphinx/src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,35 @@ At it's most basic, you can download and compile ``singularity-eos`` with:
git clone --recursive git@github.com:lanl/singularity-eos.git
cd singularity-eos
mkdir bin
cd bin
cmake -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF ..
mkdir -p build && cd build
cmake -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF -DSINGULARITY_BUILD_EXAMPLES=ON -DSINGULARITY_BUILD_TESTS=ON ..
make -j
make install # optional: install into directory defined via CMAKE_INSTALL_PREFIX
This will download ``singularity-eos`` with no optional dependencies and
compile the capabilities available in that form. For more details, see
:ref:`our build page <building>`.

You can also run unit tests by calling

.. code-block::
make test
which should produce output confirming that several tests pass.

Once compiled, you can quickly check your build/install by going to
``build/example`` and running ``./get_sound_speed_press``. You should be
able to see the following output:

.. code-block::
The final values are:
rho = 0.987467
uu = 0.00987467
P = 0.0059248
cs = 0.0979796
If the library is in your include and lib paths (or you built it
in-tree), you can include the ``eos`` part of the library with

Expand Down
6 changes: 3 additions & 3 deletions doc/sphinx/src/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ If the unitless user parameter :math:`b=\Gamma_0`, the Gruneisen parameter is of
form where :math:`\Gamma_0 =` constant in compression. These two limitig cases are
shown in the figure below.

.. image:: ../SteinbergGammarho.pdf
.. image:: ../SteinbergGammarho.png
:width: 500
:alt: Figure: Demonstration of how the parameter b interpolated between two common approximations for Gamma

Expand Down Expand Up @@ -978,7 +978,7 @@ The first omitted term in the expansion inside the square brackets is :math:`\Ga
in fact even better than the common approximation of replacing the full temperature on the Hugoniot with the temperature on the
isentrope, that is, the first term :math:`T_0 e^{\Gamma(\rho_0) \eta}`.

.. image:: ../ApproxForTH.pdf
.. image:: ../ApproxForTH.png
:width: 500
:alt: Figure: Different approximations for the temperature on the Hugoniot.

Expand Down Expand Up @@ -1018,7 +1018,7 @@ By expanding the MGUsup Hugoniot pressure into a power series in :math:`\eta` we
In the figure below we have used :math:`M=20` with these coefficients and show how the divergence in the MGUsup pressure at :math:`\eta = \frac{1}{s}` is avoided in the PowerMG, making it more suitable for modeling high pressures.

.. image:: ../PMGvsMGUsupPress.pdf
.. image:: ../PMGvsMGUsupPress.png
:width: 500
:alt: Figure: Comparing Hugoniot pressure for PowerMG and MGUsup

Expand Down
4 changes: 4 additions & 0 deletions doc/sphinx/src/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Singularity EOS provides Python bindings which can be enabled with the CMake
``SINGULARITY_BUILD_PYTHON`` option. They provide a 1:1 mapping of the C++ EOS
types and give access to both scalar and vector functions.

Where you build or install your python bindings to must be included in
your python module search path. For example, if you do not install,
this may be ``singularity-eos/build/python``.

.. note::

At this time, all Python bindings are host-only.
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/src/using-kpt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ transportation rate from/to phases ``fromto[k]``, with ``k`` a phase transition
in ``fromto``, "ij", is composed from the ``gibbs`` index of the "from" phase, :math:`i`, and the ``gibbs`` index of the "to" phase,
:math:`j`, as :math:`i*10+j`, and with a single digit integer, "x", interpreted as "0x".

.. image:: ../GibbsOrder.pdf
.. image:: ../GibbsOrder.png
:width: 500
:alt: Figure: How the phase transition index used in several arrays relate to the phase index in the gibbsorder array.

Expand Down

0 comments on commit 0066727

Please sign in to comment.