From 5041cd53b244c1e3c222cb3e9f534f97047900d3 Mon Sep 17 00:00:00 2001 From: Corentin Cadiou Date: Wed, 30 Aug 2023 17:30:02 +0200 Subject: [PATCH] Update doc --- doc/source/Installation.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/source/Installation.rst b/doc/source/Installation.rst index ad6926cd..d8119999 100644 --- a/doc/source/Installation.rst +++ b/doc/source/Installation.rst @@ -49,10 +49,11 @@ Installing with Rockstar support Rockstar support requires ``yt_astro_analysis`` to be installed from source. Before that, the ``rockstar-galaxies`` code must also be installed. -Using ``conda`` -^^^^^^^^^^^^^^^ +Installing ``rockstar-galaxies`` through ``conda`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If you are using ``conda`` to manage packages, you can install ``rockstar-galaxies`` as follows + .. code-block:: bash $ conda install -c conda-forge rockstar-galaxies @@ -64,8 +65,8 @@ Then, go into the ``yt_astro_analysis`` source directory and install it. $ cd yt_astro_analysis $ pip install -e . -Building ``rockstar-galaxies`` from source -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Installing ``rockstar-galaxies`` from source +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Alternatively, you can install ``rockstar-galaxies`` from source. Two recommended repositories exist for installing ``rockstar-galaxies``, @@ -99,6 +100,8 @@ the location of ``librockstar-galaxies.so`` is in your LD_LIBRARY_PATH. $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH: +Note about ``rockstar-galaxies`` version +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. warning:: If using the conda version or building from source with `Peter Behroozi's repository `__, the following