Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .dockerignore

This file was deleted.

21 changes: 0 additions & 21 deletions Dockerfile

This file was deleted.

163 changes: 0 additions & 163 deletions Jenkinsfile

This file was deleted.

28 changes: 14 additions & 14 deletions docsrc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ Installation
============

CmdStanPy is a pure-Python3 package, but it relies on CmdStan for all
of its functionality. There are several ways to install CmdStan and CmdStanPy,
which depend on the kind of user you are.
of its functionality. There are several ways to install CmdStan and CmdStanPy,
which depend on the kind of user you are.


Conda users (Recommended)
-------------------------

If you use `conda <https://docs.conda.io/en/latest/>`__,
If you use `conda <https://docs.conda.io/en/latest/>`__,
installation of both can be done very simply. CmdStanPy
and CmdStan are both available via the
and CmdStan are both available via the
`conda-forge <https://conda-forge.org/>`__ repository.

We recommend creating a new environment for CmdStan[Py]:
Expand All @@ -33,13 +33,13 @@ or whichever name you used for your environment (following ``-n``
above).

Note that CmdStan is only available on conda for versions
2.27.0 and newer. If you require an older version, you must use
2.26.1 and newer. If you require an older version, you must use
one of the following methods to install it. If you require a
version of CmdStan *newer* than 2.27.0, but not the latest,
version of CmdStan *newer* than 2.26.1", but not the latest,
you can install it in the standard conda way by specifying
``cmdstan==VERSION`` in the install command.

Pip (non-Conda) users
Pip (non-Conda) users
-------------------------

CmdStan can also be installed from PyPI via URL: https://pypi.org/project/cmdstanpy/ or from the
Expand Down Expand Up @@ -67,13 +67,13 @@ To install the current develop branch from GitHub:


If you install CmdStanPy from GitHub,
**you must install CmdStan**. The recommended way for Pip users
to do so is via the ``install_cmdstan`` function
**you must install CmdStan**. The recommended way for Pip users
to do so is via the ``install_cmdstan`` function
:ref:`described below<install-cmdstan-fun>`

.. note::
.. note::

**Note for PyStan & RTools users:** PyStan and CmdStanPy should be installed in
**Note for PyStan & RTools users:** PyStan and CmdStanPy should be installed in
separate environments if you are using the RTools toolchain (primarily Windows users).
If you already have PyStan installed, you should take care to install CmdStanPy in its own
virtual environment.
Expand All @@ -88,7 +88,7 @@ to do so is via the ``install_cmdstan`` function
`ipywidgets installation instructions <https://ipywidgets.readthedocs.io/en/latest/user_install.html#>`_
and `this tqdm GitHub issue <https://github.com/tqdm/tqdm/issues/394#issuecomment-384743637>`_.



Installing CmdStan
------------------
Expand Down Expand Up @@ -146,7 +146,7 @@ can be used to override these defaults:
install_cmdstan -d my_local_cmdstan -v 2.20.0
ls -F my_local_cmdstan

DIY Installation
DIY Installation
^^^^^^^^^^^^^^^^

If you with to install CmdStan yourself, follow the instructions
Expand Down Expand Up @@ -191,4 +191,4 @@ To use custom ``make``-tool use ``set_make_env`` function.

.. [1] In very early versions, this hidden directory was named ``.cmdstanpy``