Skip to content

Commit

Permalink
build -> builddir as easier to distinguish names. Remove the unit tes…
Browse files Browse the repository at this point in the history
…ts from getting started.
  • Loading branch information
jonahm-LANL committed Oct 31, 2024
1 parent a1440fc commit 1e88aaa
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 16 deletions.
2 changes: 1 addition & 1 deletion doc/sphinx/src/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ time. For example:
.. code-block:: bash
# from singularity-eos repo
mkdir -p build && cd build
mkdir -p builddir && cd builddir
cmake .. -DSINGULARITY_BUILD_EXAMPLES=ON ..
make -j
Expand Down
19 changes: 5 additions & 14 deletions doc/sphinx/src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,16 @@ At it's most basic, you can download and compile ``singularity-eos`` with:
git clone --recursive [email protected]:lanl/singularity-eos.git
cd singularity-eos
cmake -B builddir -S . -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF -DSINGULARITY_BUILD_EXAMPLES=ON -DSINGULARITY_BUILD_TESTS=ON
cmake --build build --parallel
cmake --install build # optional: install into directory defined via CMAKE_INSTALL_PREFIX
cmake -B builddir -S . -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF -DSINGULARITY_BUILD_EXAMPLES=ON
cmake --build builddir --parallel
cmake --install builddir # 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
in the ``build`` directory, 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
Once compiled, you can quickly check your builddir/install by going to
``builddir/example`` and running ``./get_sound_speed_press``. You should be
able to see the following output:

.. code-block::
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/src/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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``.
this may be ``singularity-eos/builddir/python``.

.. note::

Expand Down

0 comments on commit 1e88aaa

Please sign in to comment.