Skip to content

Commit

Permalink
Merge pull request #49 from tbereau/patch1
Browse files Browse the repository at this point in the history
Patch1
  • Loading branch information
tbereau authored May 1, 2024
2 parents 612f240 + 4e4dfd0 commit c6264b1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ For full documentation, click [here](https://tbereau.github.io/auto_martini/docs
The `main` branch is now fully compatible with Python 3. For the original Python2-based version of the code used in the JCTC 2015 paper, see [branch original_jctc2015](https://github.com/tbereau/auto_martini/tree/original_jctc2015).

## Installation

### Installation with pip
You can install auto_martini with pip by running the following command from the source directory:
```bash
pip install .
```
If you do not wish to clone the repo, you can instead run:
```bash
pip install git+https://github.com/tbereau/auto_martini
```

### Installation with poetry
You can install auto_martini with [poetry](https://python-poetry.org) by running the following command from the source directory:
```bash
Expand All @@ -61,12 +72,17 @@ conda-lock -f pyproject.toml -k explicit --filename-template auto_martini-py3.1
```
This generates a conda lock file which you can use to create a new conda virtual environment:
```
conda create --name YOURENV --file auto_martini-py3.11.conda.lock
conda create --name YOURENV --file auto_martini-py3.11.conda.lock
```
`YOURENV` is the name of your conda env, and the lock filename can change depending on the python interpreter version.
Finally activate your conda envrionment via:
```
conda activate YOURENV
```
Now you can install the pkg with pip by running from the source directory:
```
pip install .
```
To exit the environment, simply run `conda deactivate`.

## Testing
Expand Down
7 changes: 0 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# Core package and development configuration.
# For more information on how to edit dependencies,
# view the README of https://github.com/stxinsite/private-python-library-template
#
# This configuration was originally generated by the template at
# https://github.com/stxinsite/private-python-library-template
# Consider making pyproject.toml changes to the template if they apply
# to other packages.

# Build system dependencies ----------

Expand Down

0 comments on commit c6264b1

Please sign in to comment.