From 1e88aaa9a74422f1a315f245956d9b787fd64140 Mon Sep 17 00:00:00 2001 From: Jonah Miller Date: Thu, 31 Oct 2024 16:24:59 -0600 Subject: [PATCH] build -> builddir as easier to distinguish names. Remove the unit tests from getting started. --- doc/sphinx/src/examples.rst | 2 +- doc/sphinx/src/getting-started.rst | 19 +++++-------------- doc/sphinx/src/python.rst | 2 +- 3 files changed, 7 insertions(+), 16 deletions(-) diff --git a/doc/sphinx/src/examples.rst b/doc/sphinx/src/examples.rst index 51360cf832..d4e78c439a 100644 --- a/doc/sphinx/src/examples.rst +++ b/doc/sphinx/src/examples.rst @@ -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 diff --git a/doc/sphinx/src/getting-started.rst b/doc/sphinx/src/getting-started.rst index 7c36c5c579..cfcc600818 100644 --- a/doc/sphinx/src/getting-started.rst +++ b/doc/sphinx/src/getting-started.rst @@ -9,25 +9,16 @@ 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 - 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 `. -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:: diff --git a/doc/sphinx/src/python.rst b/doc/sphinx/src/python.rst index 651d4cd0ea..e28d688646 100644 --- a/doc/sphinx/src/python.rst +++ b/doc/sphinx/src/python.rst @@ -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::