Skip to content
Permalink
Browse files
Updated dependency installation instructions.
* Added a sub-section to the README on dependency installation to
  include instructions for setting up a virtual environment using
  the built-in venv module (for non-conda users)

* Updated .gitignore to automatically ignore venv/ folder
  • Loading branch information
rossbar committed Nov 22, 2019
1 parent ab5ce38 commit 53e22f8d5dd5133a18c520cd6bae104c5df405fe
Showing with 30 additions and 1 deletion.
  1. +1 −0 .gitignore
  2. +29 −1 README.md
@@ -19,3 +19,4 @@ figures/generated/*
\#*
.ipynb_checkpoints
node_modules/
venv/
@@ -70,7 +70,10 @@ jupyter notebook
## Installing dependencies

First, we build an isolated environment as not to interrupt any
existing setup you may have. This can be done using, e.g., Conda:
existing setup you may have. This can be done using, e.g., Conda or Python's
built-in virtual environment module:

### Conda install

1. Install [conda](http://conda.pydata.org/miniconda.html) or Anaconda

@@ -85,6 +88,31 @@ conda env create --name elegant-scipy -f /path/to/elegant-scipy/environment.yml
`source activate elegant-scipy` if using conda 4.3.x or earlier, or
`activate elegant-scipy` on Windows)

### Python `venv` module

1. Create a new virtual environment:

```console
python -m venv --prompt elegant-scipy venv
```

This will create a python virtual environment named `elegant-scipy` and
store it in `./venv`.

2. Activate the newly-created environment:

```console
source venv/bin/activate
```

3. Install the dependencies with `pip`

```console
pip install -r requirements.txt
```
You can remove the virtual environment at any time by deleting the `venv/`
directory.

### Windows

To build the full book on Windows, you will at a minimum need the following

0 comments on commit 53e22f8

Please sign in to comment.