diff --git a/docs/conf.py b/docs/conf.py index 48e2087cc884d06437fac7866c8965f3de66daf2..ee2c2dfff8190e50c5a61e63a5fd8bf8aada1c54 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -106,8 +106,8 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' -#html_theme = 'default' +# html_theme = 'sphinx_rtd_theme' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. @@ -258,4 +258,4 @@ texinfo_domain_indices = True #texinfo_show_urls = 'footnote' #numpydoc option -numpydoc_show_class_members = True +# numpydoc_show_class_members = True diff --git a/docs/index.rst b/docs/index.rst index fa600a3064207e6be480b173fa05e06053573fa4..bb525d6a9fab551c3d3e196c82af8213d9af8dc3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,7 +42,6 @@ Contents: .. toctree:: :maxdepth: 2 - :numbered: introduction/index user/py/quickstart/index diff --git a/docs/introduction/install/index.rst b/docs/introduction/install/index.rst index 4917de4df661e118301d07f17cb084dff9c47edc..129999c036cd866a8bca0c0cc266baaf0f0bf163 100644 --- a/docs/introduction/install/index.rst +++ b/docs/introduction/install/index.rst @@ -4,42 +4,61 @@ Installation Use pre-built packages ---------------------- +Linux +^^^^^ + We recommend that you use our repositories hosted at `Open Build Service <http://build.opensuse.org>`_. We have packages of both ``MOOSE`` and -``moogli`` for Debian, Ubuntu, CentOS, Fedora, OpenSUSE/SUSE, RHEL, Scientific -Linux. Visit `this page +``moogli`` for following distributions + +- Debian 7.0, 8.0 +- Ubuntu 12.04, 14.04, 15.04, 15.10, 16.04 +- CentOS 6, 7 +- Fedora 20, 21, 22, 23 +- OpenSUSE 13.1, 13.2, Factory ARM, Leap 42.1, Tumbleweed +- SLE 12, 12 SP1 +- RHEL 7 +- Scientific Linux 7 + +Visit `this page <https://software.opensuse.org/download.html?project=home:moose&package=moose>`_ -and follow instructions. +pick you distribution and follow instructions. + +.. note:: + Package ``moogli`` will also be available in addition to moose on almost all + of these distributions (except CentOS-6). Use the same command to install + moogli as well e.g. ``sudo apt-get install moogli`` or ``sudo yum + install moogli``. .. raw:: html <iframe src="http://software.opensuse.org/download/package.iframe?project=<projectname>&package=<packagename>"></iframe> -After adding the repositories to your package manager (read the instructed on the site) -You can install both `moose` and `moogli` using your package manager. +.. todo:: Packages for gentoo, Arch Linux + -On ``Debian/Ubuntu`` -:: - $ sudo apt-get install moose moogli +Mac OSX +^^^^^^ -On ``CentOS/RHEL/Fedora/Scientific Linux`` -:: - $ sudo yum install moose moogli +Download the ``dmg`` file from `here <https://github.com/BhallaLab/moose/releases/download/ghevar_3.0.2/Moose_3.0.2_OSX.dmg>`_. -On ``openSUSE`` +Alternatively, you can use ``homebrew`` to install ``moose`` :: - $ sudo zypper install moose moolgi + $ brew install moose -.. todo:: Packages for gentoo, Arch Linux +.. note:: + Check the status of pull request here https://github.com/Homebrew/homebrew-science/pull/2958 -In case your distribution is not listed on `our repository page -<https://software.opensuse.org/download.html?project=home:moose&package=moose>`_ -, or if you want to build the lastest development code, following section lists -out the steps to build MOOSE from its source code. +Windows/Cygwin +^^^^^^^^^^^^^^ Building MOOSE -------------- +In case your distribution is not listed on `our repository page +<https://software.opensuse.org/download.html?project=home:moose&package=moose>`_ +, or if you want to build the lastest development code, read on. + First, you need to get the source code. You can use ``git`` (clone the repository) or download snapshot of github repo by clicking on `this link <https://github.com/BhallaLab/moose/archive/master.zip>`_.:: @@ -197,7 +216,8 @@ On ``openSUSE`` :: $ sudo zypper install python-sip python-qt4-devel libqt4-devel python-qt4 -After this, building and installing ``moogli`` should be as simple as:: +After this, building and installing ``moogli`` should be as simple as +:: $ cd /path/to/moogli $ mkdir _build $ cd _build