Skip to content
This repository has been archived by the owner on Mar 19, 2021. It is now read-only.

Commit

Permalink
docs: Update links, info about PyStan 3
Browse files Browse the repository at this point in the history
  • Loading branch information
riddell-stan committed Feb 14, 2021
1 parent 99d690d commit b34fbf6
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ PyStan: The Python Interface to Stan

|pypi| |travis| |appveyor| |zenodo|

.. tip:: PyStan 3 is available for Linux and macOS users. Visit the `PyStan 3 documentation <https://pystan.readthedocs.io/en/latest/>`_ for details. PyStan 2 is not maintained.

**PyStan** provides a Python interface to Stan, a package for Bayesian inference
using the No-U-Turn sampler, a variant of Hamiltonian Monte Carlo.

Expand All @@ -17,7 +19,7 @@ see the Stan User's Guide and Reference Manual at `http://mc-stan.org/
Important links
---------------

- HTML documentation: https://pystan.readthedocs.org
- HTML documentation: https://pystan2.readthedocs.org
- Issue tracker: https://github.com/stan-dev/pystan/issues
- Source code repository: https://github.com/stan-dev/pystan
- Stan: http://mc-stan.org/
Expand Down Expand Up @@ -49,7 +51,7 @@ Detailed installation instructions can be found in the

Windows Installation Instructions
---------------------------------
Detailed installation instructions for Windows can be found in docs under `PyStan on Windows <https://pystan.readthedocs.io/en/latest/windows.html>`_
Detailed installation instructions for Windows can be found in docs under `PyStan on Windows <https://pystan2.readthedocs.io/en/latest/windows.html>`_

Quick Installation (Linux and macOS)
------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions doc/Run_PyStan_in_Atom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ PyStan doesn't automatically run in `Atom <http://atom.io>`_ even if we use scri

Steps
------
- Install PyStan as explained `here <http://pystan.readthedocs.io/en/latest/windows.html#windows>`_.
- Install PyStan as explained `here <http://pystan2.readthedocs.io/en/latest/windows.html#windows>`_.
- Install `Atom <http://atom.io>`_. Atom will be added to your path variable during the installation.
- Launch `Atom <http://atom.io>`_ in your activated Stan environment as follows:

Expand All @@ -20,7 +20,7 @@ Steps

Test
------
To check if you can now run PyStan in Atom, copy and run the example code from the `installation doc <http://pystan.readthedocs.io/en/latest/windows.html#windows>`_.
To check if you can now run PyStan in Atom, copy and run the example code from the `installation doc <http://pystan2.readthedocs.io/en/latest/windows.html#windows>`_.

>>> import pystan
>>> model_code = 'parameters {real y;} model {y ~ normal(0,1);}'
Expand Down
4 changes: 3 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
PyStan: The Python Interface to Stan
====================================

.. tip:: PyStan 3 is available for Linux and macOS users. Visit the `PyStan 3 documentation <https://pystan.readthedocs.io/en/latest/>`_ for details. PyStan 2 is not maintained.

PyStan provides an interface to `Stan <http://mc-stan.org>`_, a package for
Bayesian inference using the No-U-Turn sampler, a variant of Hamiltonian Monte
Carlo.
Expand Down Expand Up @@ -51,7 +53,7 @@ Important links
---------------

- Source code repo: https://github.com/stan-dev/pystan
- HTML documentation: http://pystan.readthedocs.org
- HTML documentation: http://pystan2.readthedocs.org
- Issue tracker: https://github.com/stan-dev/pystan/issues

Related projects
Expand Down
2 changes: 1 addition & 1 deletion doc/release-howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ PyStan 2.14.0.0 (subject is "pystan 2.14.0.0 released on PyPI")::

A list of changes is available in the customary location:

http://pystan.readthedocs.io/en/latest/whats_new.html
http://pystan2.readthedocs.io/en/latest/whats_new.html

TODO
====
Expand Down

0 comments on commit b34fbf6

Please sign in to comment.