1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
|
.. currentmodule:: altair
.. _installation:
Installation
============
Altair can be installed, along with the example datasets in vega_datasets_, using:
.. code-block:: bash
pip install altair vega_datasets
If you are using the conda_ package manager, the equivalent is:
.. code-block:: bash
conda install -c conda-forge altair vega_datasets
At this point, you should be able to open `Jupyter Notebook`_ or `JupyterLab`_
and execute any of the code from the :ref:`example-gallery`.
For more information on how to display charts in various notebook environments
and non-notebook IDEs, see :ref:`displaying-charts`.
Development Installation
========================
The `Altair source repository`_ is available on GitHub. Once you have cloned the
repository and installed all the above dependencies, run the following command
from the root of the repository to install the master version of Altair:
.. code-block:: bash
pip install -e .
To install development dependencies as well, run
.. code-block:: bash
pip install -e .[dev]
If you do not wish to clone the source repository, you can install the
development version directly from GitHub using:
.. code-block:: bash
pip install -e git+https://github.com/altair-viz/altair.git
Please see `CONTRIBUTING.md <https://github.com/altair-viz/altair/blob/master/CONTRIBUTING.md>`_
for details on how to contribute to the Altair project.
.. _conda: https://docs.conda.io/
.. _Vega-Lite: http://vega.github.io/vega-lite
.. _vega_datasets: https://github.com/altair-viz/vega_datasets
.. _JupyterLab: http://jupyterlab.readthedocs.io/
.. _Jupyter Notebook: https://jupyter-notebook.readthedocs.io/
.. _Altair source repository: http://github.com/altair-viz/altair
|