Skip to content

Commit 1769258

Browse files
authored
[WIP] Replace installation instructions on README with wiki links (#4413)
* Updated Mauna Loa notebook * Replaced installation instructions with links to platform-specific guides on wiki * Fixed rst link syntax
1 parent c81e0c9 commit 1769258

File tree

1 file changed

+4
-73
lines changed

1 file changed

+4
-73
lines changed

README.rst

+4-73
Original file line numberDiff line numberDiff line change
@@ -77,80 +77,11 @@ and as part of `PyMCon 2020 <https://discourse.pymc.io/c/pymcon/2020talks/15>`__
7777
Installation
7878
============
7979

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

83-
The latest release of PyMC3 can be installed from Conda Forge (conda-forge):
84-
85-
::
86-
87-
conda install -c conda-forge pymc3
88-
89-
While strongly discouraged due to installation problems you could try to install PyMC3 and its dependencies via PyPI using ``pip``:
90-
91-
::
92-
93-
pip install pymc3
94-
95-
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.
96-
.. note::
97-
98-
Running ``pip install pymc`` will install PyMC 2.3, not PyMC3, from PyPI.
99-
100-
The current development branch of PyMC3 can be installed from GitHub, also using ``pip``:
101-
102-
::
103-
104-
pip install git+https://github.com./pymc-devs/pymc3
105-
106-
Make sure to install the `Theano-PyMC <https://github.com./pymc-devs/Theano-PyMC>`__ version that is pegged in ``PyMC3``'s ``requirements.txt``.
107-
For more information, see the `Theano-PyMC <https://github.com./pymc-devs/Theano-PyMC>`__ Installation section, below.
108-
109-
Lastly, another option is to clone the repository and install PyMC3 using
110-
``python setup.py install`` or ``python setup.py develop``.
111-
112-
Theano-PyMC Installation
113-
------------------------
114-
115-
PyMC3 is tested on Python 3.6, 3.7, and 3.8 and depends on NumPy, SciPy, and pandas
116-
(see `requirements.txt <https://github.com./pymc-devs/pymc3/blob/master/requirements.txt>`__ for version
117-
information).
118-
119-
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>`__.
120-
121-
That being said, you can install PyMC3 using the ``requirements.txt``
122-
file.
123-
124-
This requires cloning the repository to your computer:
125-
126-
::
127-
128-
git clone https://github.com./pymc-devs/pymc3
129-
cd pymc3
130-
pip install -r requirements.txt
131-
132-
.. note::
133-
134-
* If you have Theano installed, please remove it and install Theano-PyMC via Conda Forge, seen below:
135-
136-
``conda remove theano``
137-
138-
* If you have an outdated version of Theano-PyMC, then re-install the module via Conda Forge:
139-
140-
``conda remove theano-pymc -y``
141-
142-
``conda install -c conda-forge theano-pymc -y``
143-
144-
Arviz Installation
145-
------------------
146-
147-
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``.
148-
149-
Optional
150-
--------
151-
152-
In addtion to the above dependencies, the GLM submodule relies on
153-
`Patsy <http://patsy.readthedocs.io/en/latest/>`__.
82+
- `Installing PyMC3 on MacOS <https://github.com./pymc-devs/pymc3/wiki/Installation-Guide-(MacOS)>`__
83+
- `Installing PyMC3 on Linux <https://github.com./pymc-devs/pymc3/wiki/Installation-Guide-(Linux)>`__
84+
- `Installing PyMC3 on Windows <https://github.com./pymc-devs/pymc3/wiki/Installation-Guide-(Windows)>`__
15485

15586

15687
Citing PyMC3

0 commit comments

Comments
 (0)