Skip to content
Permalink
Browse files

DOC clarify quickstart

  • Loading branch information
mvdoc committed Dec 4, 2019
1 parent 3a2b16d commit 0ca9883f2f2994e11028661e561bd7d8fdff99f0
Showing with 10 additions and 5 deletions.
  1. +10 −5 README.md
@@ -8,18 +8,23 @@ Pycortex is a software library that allows you to visualize fMRI or other volume

Quickstart
----------
```
python3 -m venv env # use `virtualenv env` for python 3
```bash
# create a virtual environment called env with Python 3
python3 -m venv env
# activate the virtual environment
source env/bin/activate
# install some prerequisite packages
pip install -U setuptools wheel numpy cython
# install the latest release of pycortex from pip
pip install -U pycortex
```

This command creates a new [virtualenv](https://docs.python.org/3/library/venv.html) for pycortex to resolve dependencies. Run `source env/bin/activate` whenever you need pycortex.

If you want to install the latest, unreleased version of pycortex from github, instead of the last line you can run

```
```bash
# install unreleased version of pycortex from github
pip install -U git+git://github.com/gallantlab/pycortex.git
```

@@ -39,12 +44,12 @@ make html
Demo
----
Pycortex is best used with [IPython](http://www.ipython.org/). Install it in your virtualenv using
```
```bash
source env/bin/activate
pip install ipython
```
To run the pycortex demo,
```
```ipython
$ ipython
In [1]: import cortex
In [2]: cortex.webshow(cortex.Volume.random("S1", "fullhead"))

0 comments on commit 0ca9883

Please sign in to comment.
You can’t perform that action at this time.