Skip to content

Commit

Permalink
Add link to Installation guide from home page. Update to Installation…
Browse files Browse the repository at this point in the history
… guide.
  • Loading branch information
arungrace88 committed Feb 25, 2021
1 parent adbb85a commit 5afefe1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 21 deletions.
24 changes: 8 additions & 16 deletions doc/source/getting_started/Installation.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
############
Installation
############
##################
Installation guide
##################

This section provides detailed information about installing ArviZ. Most ArviZ
functionality is available with the basic requirements, but ArviZ also has optional
dependencies to further enhance the library. This guide will cover both basic and fully-fledged ArviZ installs and several installation methods.

ArviZ can be installed either using pip or conda-forge

******
Stable
******

ArviZ can be installed either using pip or conda-forge.

Using pip
=========

Expand All @@ -32,6 +33,8 @@ Using conda-forge
conda install -c conda-forge arviz
.. _dev-version:

***********
Development
***********
Expand All @@ -43,17 +46,6 @@ may use
pip install git+https://github.com/arviz-devs/arviz
ArviZ's functions work with NumPy arrays, dictionaries of arrays, xarray datasets, and has built-in support for `PyMC3 <https://docs.pymc.io/>`_,
`PyStan <https://pystan.readthedocs.io/en/latest/>`_, `CmdStanPy <https://github.com/stan-dev/cmdstanpy>`_,
`Pyro <http://pyro.ai/>`_, `NumPyro <http://num.pyro.ai/>`_,
`emcee <https://emcee.readthedocs.io/en/stable/>`_, and
`TensorFlow Probability <https://www.tensorflow.org/probability>`_ objects. Support for PyMC4, Edward2, and Edward are on the roadmap.

A Julia wrapper, `ArviZ.jl <https://arviz-devs.github.io/ArviZ.jl/stable/>`_ is
also available. It provides built-in support for
`Turing.jl <https://turing.ml/dev/>`_, `CmdStan.jl
<https://github.com/StanJulia/CmdStan.jl>`_, `StanSample.jl
<https://github.com/StanJulia/StanSample.jl>`_ and `Stan.jl <https://github.com/StanJulia/Stan.jl>`_.
************
Dependencies
Expand Down Expand Up @@ -88,7 +80,7 @@ The list of optional dependencies to further enhance ArviZ are.

- UltraJSON

If available, ArviZ makes use of faster ujson when ``arviz.from_json(filename)`` is
If available, ArviZ makes use of faster ujson when :func:`arviz.from_json` is
invoked. UltraJSON can be either installed via `pip <https://pypi.org/project/ujson/>`_ or `conda <https://anaconda.org/anaconda/ujson>`_.

- Dask
Expand Down
6 changes: 1 addition & 5 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,7 @@ Alternatively you can use conda-forge
conda install -c conda-forge arviz
For the latest (unstable) version

.. code:: bash
pip install git+https://github.com/arviz-devs/arviz
To install the latest development version of ArviZ, please check the :ref:`Installation guide <dev-version>` for details.

**Contributions** and **issue reports** are very welcome at `the github repository <https://github.com/arviz-devs/arviz>`_. We have a `contributing guide <https://github.com/arviz-devs/arviz/blob/main/CONTRIBUTING.md>`_ to help you through the process. If you have any doubts, please do not hesitate to contact us on `gitter <https://gitter.im/arviz-devs/community>`_.

Expand Down

0 comments on commit 5afefe1

Please sign in to comment.