Skip to content

Commit

Permalink
docs: Add instructions for local install to introduction (#53)
Browse files Browse the repository at this point in the history
* Add recommendation to clone locally.
* Use `--channel conda-forge` in conda install example to ensure conda-forge is used.
* Use full name of pip flags for readability.
  • Loading branch information
matthewfeickert authored Jul 26, 2023
1 parent b364b4e commit 9c60adf
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions book/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,7 @@ If you haven't already, make a new Python 3 virtual environment and then install
or [Conda-forge](https://anaconda.org/conda-forge/pyhf)

```
(pyhf-tutorial) $ conda config --add channels conda-forge
(pyhf-tutorial) $ conda install pyhf
(pyhf-tutorial) $ conda install --channel conda-forge pyhf
```

### Installation Extras
Expand Down Expand Up @@ -135,16 +134,23 @@ See our [installation docs](https://pyhf.readthedocs.io/en/v0.7.2/installation.h

### Dependencies for this tutorial

To get all the dependencies needed for this tutorial you can just install from the included `requirements.txt` in the top level `binder/` directory of [the source repository](https://github.com/pyhf/pyhf-tutorial)
To get all the dependencies needed for this tutorial first clone the repository locally

```
(pyhf-tutorial) $ python -m pip install -r binder/requirements.txt
(pyhf-tutorial) $ git clone https://github.com/pyhf/pyhf-tutorial.git
(pyhf-tutorial) $ cd pyhf-tutorial
```

then you can just install from the included `requirements.txt` in the top level `binder/` directory of [the source repository](https://github.com/pyhf/pyhf-tutorial)

```
(pyhf-tutorial) $ python -m pip install --upgrade --requirement binder/requirements.txt
```

If you want to also get the dependencies to build and explore the Jupyter Book form of the tutorial you can install them with

```
(pyhf-tutorial) $ python -m pip install -r book/requirements.txt
(pyhf-tutorial) $ python -m pip install --upgrade --requirement book/requirements.txt
```

### Citation
Expand Down

0 comments on commit 9c60adf

Please sign in to comment.