Skip to content

Commit

Permalink
- add dev-installation instruction to install documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amkrajewski committed Oct 6, 2023
1 parent 186cd5e commit f76a6d6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,14 @@ Then, move to the pySIPFENN folder and install in editable (`-e`) mode

cd pySIPFENN
pip install -e .

# Developer Install

If you want to utilize pySIPFENN beyond its core functionalities, for instance, to train new models on custom datasets
or to export models in different formats or precisions, you need to install additional dependencies. This can be done
by installing the `dev` extras with

pip install pysipfenn[dev]

> Note: If you are using MacOS zsh shell, you may need to enclose the `dev` extras in quotes like
> `pip install "pysipfenn[dev]"` or `pip install ".[dev]"`.

0 comments on commit f76a6d6

Please sign in to comment.