Skip to content

Commit

Permalink
Merge pull request #44 from INM-6/packaging
Browse files Browse the repository at this point in the history
update installation instructions in README.md
  • Loading branch information
shashwatsridhar authored Jun 16, 2021
2 parents 9fd9c9d + 67b4577 commit ecd4266
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,29 +49,20 @@ We recommend installing SWAN in a conda or virtualenv environment. The installat

### Using Conda

```shell script
```shell
conda create -n swan python=3
conda activate swan
pip install -e git+https://github.com/INM-6/swan.git#egg=swan
pip install python-swan
```

### Using Python Virtualenv

```shell script
```shell
virtualenv venv
source activate venv/bin/activate
pip install -e git+https://github.com/INM-6/swan.git#egg=swan
```

### Custom source location

To install SWAN from source stored at a custom location on the system, use the following command in your desired conda or virtualenv environment.

```shell script
pip install -e /path/to/souce
pip install python-swan
```


## Getting Started

Once installed, start SWAN using
Expand Down

0 comments on commit ecd4266

Please sign in to comment.