From b98ef3dcf2a69267036a80ae5a635a4983245249 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Fri, 20 Sep 2024 15:11:51 -0400 Subject: [PATCH] added more installation details --- docs/index.rst | 1 + docs/installation.rst | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 421b51b..edd60a3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,6 +31,7 @@ To install libra-toolbox, use pip: pip install git+https://github.com/LIBRA-project/libra-toolbox +For more details, see the :ref:`installation` page. Roadmap ------- diff --git a/docs/installation.rst b/docs/installation.rst index 7600110..c7b308d 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,3 +1,5 @@ +.. _installation: + Installation ============ @@ -9,3 +11,18 @@ To install ``libra-toolbox``, use pip: pip install git+https://github.com/LIBRA-project/libra-toolbox +This will install the latest version of the code along with all the dependencies (``numpy``, ``pint``, ``scipy``...). + +To install a specific version of the code: + +.. code-block:: bash + + pip install git+https://github.com/LIBRA-project/libra-toolbox@v0.1 + +Here, ``v0.1`` is the version number. You can replace it with the version you want to install. + +To uninstall the package: + +.. code-block:: bash + + pip uninstall libra-toolbox