Skip to content

Commit

Permalink
docs: update conda install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Sieboldianus committed Dec 19, 2020
1 parent 1643112 commit 4f0f96b
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/quick-guide.md
Expand Up @@ -25,9 +25,29 @@ conda env create -f environment.yml

```bash
conda activate lbsntransform
python setup.py install --no-deps
```

Option A: Using distutils, linking the lbsntransform folder.

This is the recommended way if you want to edit files, or update to
the latest version using git.

The `lbsntransform` package will be directly linked to the folder.

```
python setup.py install develop
```

Option B: Using pip. This will create a static installation that needs
to be manually upgraded when new package versions appear.

```
pip install . --no-deps
```

??? "Why isn't the package available on conda-forge?"
This is planned to happen in one of the next versions..

# Windows

There are many ways to install python tools, in Windows this can become particularly frustrating.
Expand Down

0 comments on commit 4f0f96b

Please sign in to comment.