From 9bc5f34ff23ffa9846059005bb2c34c2d0d5bab9 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Thu, 19 Dec 2024 16:39:34 -0500 Subject: [PATCH] updated installation instructions + renamed optional dependencies set --- README.md | 17 +---------------- docs/installation.rst | 14 ++++++++++++++ pyproject.toml | 2 +- 3 files changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a3afaf1..e2bb265 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,7 @@ ## Installation -`libra-toolbox` relies on Python. You can install it from the official website: [python.org](https://www.python.org/downloads/). - -Install OpenMC: - -If you want to run OpenMC functions, [install OpenMC](https://docs.openmc.org/en/stable/quickinstall.html) with conda: - -``` -conda install -c conda-forge openmc>=0.14.0 -``` - - -To install `libra-toolbox`, use pip: - -```bash -pip install git+https://github.com/LIBRA-project/libra-toolbox -``` +You can find the [installation instructions](https://libra-toolbox.readthedocs.io/en/latest/installation.html#installation) in the documentation. ## Documentation The documentation for `libra-toolbox` is built using Sphinx and is [available online](https://libra-toolbox.readthedocs.io/en/latest/). To build the documentation locally, you can use the provided Makefile or make.bat script. diff --git a/docs/installation.rst b/docs/installation.rst index c7b308d..e0821cc 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -21,6 +21,20 @@ To install a specific version of the code: Here, ``v0.1`` is the version number. You can replace it with the version you want to install. +To install the code in editable mode (i.e. the code is installed in the current directory and any changes to the code are immediately available to the user): + +.. code-block:: bash + + git clone https://github.com/LIBRA-project/libra-toolbox + cd libra-toolbox + pip install -e . + +To install the code alongside with the optional dependencies for the neutronics module, first [install OpenMC](https://docs.openmc.org/en/stable/quickinstall.html) with conda: + +``` +conda install -c conda-forge openmc>=0.14.0 +``` + To uninstall the package: .. code-block:: bash diff --git a/pyproject.toml b/pyproject.toml index a523457..3a4f85c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ dynamic = ["version"] dependencies = ["numpy", "pint", "scipy", "matplotlib", "sympy", "pandas"] [project.optional-dependencies] -extra-feature = ["openmc>=0.14.0", "h5py"] +neutronics = ["openmc>=0.14.0", "h5py"] tests = ["pytest>=5.4.3", "pytest-cov", "nbconvert", "ipykernel"] [tool.setuptools_scm]