From ae9fc5b5cd7e3ecd3100d32e644f6f05c1200d9b Mon Sep 17 00:00:00 2001 From: Marion Le Borgne Date: Tue, 12 Sep 2017 20:09:41 +0200 Subject: [PATCH] ADD: PyPI + install details --- README.rst | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index f2da01a..eecfa95 100644 --- a/README.rst +++ b/README.rst @@ -20,23 +20,34 @@ visualization. Using CloudBrain ================ -Setup ------ +Installing +---------- +Cloudbrain is available for download via `PyPI `_ 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 `_ 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 +----------------- ::