Skip to content
Snippets Groups Projects
Unverified Commit 4cb3d294 authored by Dilawar Singh's avatar Dilawar Singh Committed by GitHub
Browse files

Merge pull request #246 from BhallaLab/dilawar-patch-1

Update install.rst
parents 049a52f2 946efbb0
No related branches found
No related tags found
No related merge requests found
...@@ -4,12 +4,16 @@ Use pre-built packages ...@@ -4,12 +4,16 @@ Use pre-built packages
pip pip
^^^^ ^^^^
If you only need `python` interface, use `pip`. This is the easiest way to install Python interface. If you only need `python` interface, the recommended way is via `pip`.
This solution has been tested for Linux and MacOSX.
:: ::
pip install pymoose pip install pymoose --user
To install nightly version
::
pip install pymoose --pre --upgrade --user
We also build moose package with additional components such as gui and `moogli`. We also have moose package with additional components such as gui and `moogli`.
Linux Linux
^^^^^^ ^^^^^^
...@@ -28,7 +32,9 @@ to pick your distribution and follow instructions. ...@@ -28,7 +32,9 @@ to pick your distribution and follow instructions.
Mac OSX Mac OSX
^^^^^^^^ ^^^^^^^^
MacOSX support for moose-gui is not complete yet. However, the python-scripting interface can be installed on OSX using ``homebrew`` MacOSX support for moose-gui is not complete yet because moose-gui depends on PyQt4 but that
world has moved onto PyQt5 (See the status here: https://github.com/BhallaLab/moose-gui/issues/16).
However, the python-scripting interface can be installed on OSX using ``homebrew``
:: ::
$ brew tap BhallaLab/moose $ brew tap BhallaLab/moose
$ brew install moose $ brew install moose
...@@ -83,36 +89,33 @@ Core MOOSE ...@@ -83,36 +89,33 @@ Core MOOSE
"""""""""" """"""""""
- Required: - Required:
- cmake (version 2.8 or higher) - cmake (version 2.8 or higher)
- g++ (>= 4.6.x) For building the C++ MOOSE core. - g++ or clang (with `c++11` support).
- gsl-1.16 or higher. - gsl-1.16 or higher.
- Optional - Optional
- HDF5 (>=1.8.x) For reading and writing data into HDF5 based formats - HDF5 (>=1.8.x) For reading and writing data into HDF5 based formats. Disabled by default.
Python interface for core MOOSE API (pymoose) Python interface for core MOOSE API (pymoose)
""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""
- Required - Required
- Python2 ( >= 2.7.x) For building the MOOSE Python bindings - python (Both 2.7 and 3.x versions are supported).
- Python-dev ( >= 2.7.x) Python development headers and libraries, e.g. `python-dev` or `python-devel` - python-dev. Python development headers and libraries, e.g. `python-dev` or `python-devel`
- NumPy ( >= 1.6.x) For array interface, e.g. `python-numpy` or `numpy` - NumPy ( >= 1.6.x) For array interface, e.g. `python-numpy` or `numpy`
- Optional - Optional
- NetworkX (1.x) For automatical layout - networkx (>=1.x) For automatical layout
- pygraphviz For automatic layout for chemical models - pygraphviz. For automatic layout for chemical models
- Matplotlib (>=1.1.x) For plotting simulation results - matplotlib (>=2.x). For plotting simulation results
- python-libsbml For reading and writing chemical models from and into SBML format - python-libsbml. For reading and writing chemical models from and into SBML format
- pylibsbml
Most of the dependencies can be installed using package manager. All of these dependencies can be installed using `pip` or your package manager.
On ``Debian/Ubuntu`` On ``Debian/Ubuntu``
:: ::
$ sudo apt-get install libhdf5-dev cmake libgsl0-dev libpython-dev python-numpy $ sudo apt-get install libhdf5-dev cmake libgsl0-dev libpython-dev python-numpy
.. note::
Ubuntu 12.04 does not have required version of ``gsl`` (required 1.16 or
higher, available 1.15). On Ubuntu 16.04, package name is ``libgsl-dev``.
On ``CentOS/Fedora/RHEL/Scientific Linux`` On ``CentOS/Fedora/RHEL/Scientific Linux``
:: ::
...@@ -124,7 +127,7 @@ On ``OpenSUSE`` ...@@ -124,7 +127,7 @@ On ``OpenSUSE``
$ sudo zypper install hdf5-devel cmake libgsl-dev python-devel python-numpy $ sudo zypper install hdf5-devel cmake libgsl-dev python-devel python-numpy
build moose Build moose
^^^^^^^^^^^ ^^^^^^^^^^^
.. code-block:: bash .. code-block:: bash
...@@ -183,12 +186,12 @@ Alternatively the moose-gui folder exists within the moose folder downloaded and ...@@ -183,12 +186,12 @@ Alternatively the moose-gui folder exists within the moose folder downloaded and
Below are packages which you may want to install to use MOOSE Graphical User Interface. Below are packages which you may want to install to use MOOSE Graphical User Interface.
- Required: - Required:
- PyQt4 (4.8.x) For Python GUI - PyQt4 (4.8.x). For Python GUI
- Matplotlib ( >= 1.1.x) For plotting simulation results - Matplotlib ( >= 2.x). For plotting simulation results
- NetworkX (1.x) For automatical layout - NetworkX (1.x). For automatical layout
- suds/suds-jurko (0.4) For accessing models hosted on biomodels database.
- Optional: - Optional:
- python-libsbml For reading and writing signalling models from and into SBML format - python-libsbml. For reading and writing signalling models from and into SBML format
On ``Ubuntu/Debian``, these can be installed with On ``Ubuntu/Debian``, these can be installed with
:: ::
...@@ -258,7 +261,7 @@ After this, building and installing ``moogli`` should be as simple as ...@@ -258,7 +261,7 @@ After this, building and installing ``moogli`` should be as simple as
$ mkdir _build $ mkdir _build
$ cd _build $ cd _build
$ cmake .. $ cmake ..
$ make $ make -j3
$ sudo make install $ sudo make install
If you run into troubles, please report it on our `github repository If you run into troubles, please report it on our `github repository
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment