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
58
59
60
61
62
63
64
65
|
.. _installing:
Installing and getting started
------------------------------
To install the released version of seaborn, you can use ``pip`` (i.e. ``pip install seaborn``).
Alternatively, you can use ``pip`` to install the development version, with the command ``pip install
git+git://github.com/mwaskom/seaborn.git#egg=seaborn``. Another option would be
to to clone the `github repository <https://github.com/mwaskom/seaborn>`_ and
install with ``pip install .`` from the source directory. Seaborn itself is pure
Python, so installation should be reasonably straightforward.
Dependencies
~~~~~~~~~~~~
We recommend using seaborn with the `Anaconda distribution <https://store.continuum.io/cshop/anaconda/>`_.
- Python 2.7 or 3.3+
Mandatory dependencies
^^^^^^^^^^^^^^^^^^^^^^
- `numpy <http://www.numpy.org/>`__
- `scipy <http://www.scipy.org/>`__
- `matplotlib <matplotlib.sourceforge.net>`__
- `pandas <http://pandas.pydata.org/>`__
Recommended dependencies
^^^^^^^^^^^^^^^^^^^^^^^^
- `statsmodels <http://statsmodels.sourceforge.net/>`__
- `patsy <http://patsy.readthedocs.org/en/latest/>`__
Version-wise, we make an attempt to keep seaborn working on the stable Debian
channels. There may be cases where some more advanced features only work with
newer versions of these dependencies, although these should be rare. There are
also some known bugs on older versions of matplotlib, so you should in general
try to use a modern version, but for many cases older matplotlibs will work
fine. Seaborn is tested on the most recent versions offered through ``conda``.
Import conventions
~~~~~~~~~~~~~~~~~~
By convention, ``seaborn`` is abbreviated to ``sns`` on imports.
Testing
~~~~~~~
To test seaborn, run ``make test`` in the root directory of the source
distribution. This runs the unit test suite (which can also be exercised
separately by running ``nosetests``). It also runs the code in the example
notebooks to smoke-test a broader and more realistic range of example usage.
Bugs
~~~~
Please report any bugs you encounter through the github `issue tracker
<https://github.com/mwaskom/seaborn/issues/new>`_. It will be most helpful to
upload an IPython notebook that can reproduce the error in a `gist
<http://gist.github.com>`_ and link to that gist in the bug report.
|
