Skip to content

Commit

Permalink
change to pyproject.toml
Browse files Browse the repository at this point in the history
change to pyproject.toml
  • Loading branch information
skuschel authored Nov 24, 2023
2 parents 2d0e4a1 + 565b2f6 commit 163a57e
Show file tree
Hide file tree
Showing 6 changed files with 1,109 additions and 447 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,35 @@ Please see the [tutorial notebook](generatorpipeline-tutorial.ipynb) for an over


# Installation
Python 2 is NOT supported. You must use __python version 3.6__ or higher! Install using
Python 2 is NOT supported. You must use __python version 3.6__ or higher!

1) The recommended way is to create a python venv and install it into the venv. Create a new virtualenv by
```
pip install --user generatorpipeline[full]@git+https://github.com/skuschel/generatorpipeline.git
python -m venv --system-site-packages ~/.venv/defaultpyvenv
```

2) activate the environment using `source ~/.venv/defaultpyvenv/bin/activate`.

3) Install into the venv
```
pip install generatorpipeline[full]@git+https://github.com/skuschel/generatorpipeline.git
```

# Installation for developers

Follow steps 1 and 2 of the normal installation to create and activate a venv.

3) git clone this repository
```
git clone git@github.com:skuschel/generatorpipeline.git
```

4) Install in editable mode using
```
pip install -e .
```



# Contributing
... is always welcome! Development and issue tracker can be found on github. Please report bugs to
Expand Down
Loading

0 comments on commit 163a57e

Please sign in to comment.