Skip to content

Commit

Permalink
updated installation instructions + renamed optional dependencies set
Browse files Browse the repository at this point in the history
  • Loading branch information
RemDelaporteMathurin committed Dec 19, 2024
1 parent 697dfd4 commit 9bc5f34
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 14 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 9bc5f34

Please sign in to comment.