Skip to content

Commit

Permalink
ADD: PyPI + install details
Browse files Browse the repository at this point in the history
  • Loading branch information
marionleborgne authored Sep 12, 2017
1 parent 9ae81c9 commit ae9fc5b
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,34 @@ visualization.
Using CloudBrain
================

Setup
-----
Installing
----------
Cloudbrain is available for download via `PyPI <https://pypi.python.org/pypi/cloudbrain>`_ and may be installed using ``pip``:

- Run: ``pip install . --user``
- If you plan to *edit* the code, make sure to use the ``-e`` switch:
``pip install -e . --user``
::

Optional
--------
pip install cloudbrain


Installing additional modules
-----------------------------

Optional CloudBrain modules can be installed:

- Analytics modules: ``pip install .[analytics] --user``
- Muse source module: ``pip install .[muse] --user`` (Python ``3.*`` only)
- Analytics modules: ``pip install cloudbrain[analytics]``
- `Muse <http://www.choosemuse.com>`_ source module: ``pip3 install cloudbrain[muse]`` (Python ``3.*`` only)


Installing from source
----------------------

- Clone this repository and run ``pip install .`` from the root of the repo.
- If you plan to *edit* the code, make sure to use the ``-e`` switch:
``pip install -e .``


Run the tests
-------------
Running the tests
-----------------

::

Expand Down

0 comments on commit ae9fc5b

Please sign in to comment.