Skip to content

[WIP] Replace installation instructions on README with wiki links #4413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jan 10, 2021
77 changes: 4 additions & 73 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,80 +77,11 @@ and as part of `PyMCon 2020 <https://discourse.pymc.io/c/pymcon/2020talks/15>`__
Installation
============

PyMC3 Installation
------------------
To install PyMC3 on your system, follow the instructions on the appropriate installation guide:

The latest release of PyMC3 can be installed from Conda Forge (conda-forge):

::

conda install -c conda-forge pymc3

While strongly discouraged due to installation problems you could try to install PyMC3 and its dependencies via PyPI using ``pip``:

::

pip install pymc3

The reason installation via PyPI is difficult, especially on Windows and OSX, is that ``Theano`` requires compilation against MKL, which is difficult to set up, while Conda comes with its own compilers and MKL installation.
.. note::

Running ``pip install pymc`` will install PyMC 2.3, not PyMC3, from PyPI.

The current development branch of PyMC3 can be installed from GitHub, also using ``pip``:

::

pip install git+https://github.com/pymc-devs/pymc3

Make sure to install the `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ version that is pegged in ``PyMC3``'s ``requirements.txt``.
For more information, see the `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ Installation section, below.

Lastly, another option is to clone the repository and install PyMC3 using
``python setup.py install`` or ``python setup.py develop``.

Theano-PyMC Installation
------------------------

PyMC3 is tested on Python 3.6, 3.7, and 3.8 and depends on NumPy, SciPy, and pandas
(see `requirements.txt <https://github.com/pymc-devs/pymc3/blob/master/requirements.txt>`__ for version
information).

Moreover, as of Late 2020, PyMC3 now requires `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ instead of `Theano <https://github.com/Theano/Theano>`__.

That being said, you can install PyMC3 using the ``requirements.txt``
file.

This requires cloning the repository to your computer:

::

git clone https://github.com/pymc-devs/pymc3
cd pymc3
pip install -r requirements.txt

.. note::

* If you have Theano installed, please remove it and install Theano-PyMC via Conda Forge, seen below:

``conda remove theano``

* If you have an outdated version of Theano-PyMC, then re-install the module via Conda Forge:

``conda remove theano-pymc -y``

``conda install -c conda-forge theano-pymc -y``

Arviz Installation
------------------

Plotting is done using `ArviZ <https://arviz-devs.github.io/arviz/>`__ - if you follow the installation instructions above, then it will be installed alongside ``PyMC3``.

Optional
--------

In addtion to the above dependencies, the GLM submodule relies on
`Patsy <http://patsy.readthedocs.io/en/latest/>`__.
- `Installing PyMC3 on MacOS <https://github.com/pymc-devs/pymc3/wiki/Installation-Guide-(MacOS)>`__
- `Installing PyMC3 on Linux <https://github.com/pymc-devs/pymc3/wiki/Installation-Guide-(Linux)>`__
- `Installing PyMC3 on Windows <https://github.com/pymc-devs/pymc3/wiki/Installation-Guide-(Windows)>`__


Citing PyMC3
Expand Down