Skip to content

Commit

Permalink
Update README.md with alternative installation methods
Browse files Browse the repository at this point in the history
Modified installation methods.
  • Loading branch information
SCMusson authored Jul 12, 2023
1 parent d1808cd commit 65fa95e
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,21 @@ To run the GUI:

## Installation ##

molearn requires no installation. Simply clone the repository and make sure the requirements above are met.
The most recent release can also be obtained through Anaconda:

`conda install molearn -c conda-forge`
`conda install molearn -c conda-forge` or the much faster `mamba install molearn -c conda-forge`

Manual installation requires three simple steps.
* Clone the repository
* Install the necessary requirements `mamba install -c conda-forge --only-deps molearn`. --only-deps will install the molearn dependencies but not molearn itself.
* Use pip to install molearn from within the molearn directory `python -m pip install .`

Molearn can used without installation by (making the sure the requirements above are met as above) and adding the `src` directory to your path at the beginning of every script e.g.
```
import sys
sys.path.insert(0, 'path/to/molearn/src')
import molearn
```

## Usage ##

Expand Down

0 comments on commit 65fa95e

Please sign in to comment.