Skip to content

Commit

Permalink
Write more detailed instructions for Python development
Browse files Browse the repository at this point in the history
  • Loading branch information
cschwan committed Aug 14, 2024
1 parent 6453887 commit b0de152
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions pineappl_py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,42 @@ Run

```shell
python -m venv env && . env/bin/activate
pip install maturin
```

to setup a new environment.
to setup a new environment and check that `pip --version` returns at least `pip
22.0 from ...`. If not, upgrade `pip` via

```shell
pip install -U pip
```

Next, install the needed dependencies:

```shell
pip install maturin
```

Run

```shell
maturin develop
```

to build the project.
to build the project, which also install it into the environment so that it can
be used in Python project using the same environment.

Run
### Documentation

Run the following once to install the documentation's dependencies:

```shell
pip install .[docs]
```

Then run

```shell
maturin develop -E docs
cd docs && make html
( cd docs && make clean html )
```

to generate the documentation.

0 comments on commit b0de152

Please sign in to comment.