Merge pull request #12 from LIBRA-project/install-details

Detailed installation instructions
LIBRA-project · Sep 20, 2024 · cec0fed · cec0fed
2 parents 86d5ad0 + b98ef3d
commit cec0fed
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git 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
@@ -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/[email protected]
+
+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
-Original file line number
+Diff line change
@@ Expand Up / @@ -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
     -------
@@ Expand Down @@