seaborn README

The project's README from github.com/mwaskom/seaborn. As one markdown file: README.md.



seaborn: statistical data visualization

PyPI Version License DOI Tests Code Coverage

Seaborn is a Python visualization library based on matplotlib. It provides a high-level interface for drawing attractive statistical graphics.

Documentation

Online documentation is available at seaborn.pydata.org.

The docs include a tutorial, example gallery, API reference, FAQ, and other useful information.

To build the documentation locally, please refer to doc/README.md.

Dependencies

Seaborn supports Python 3.10+.

Installation requires numpy, pandas, and matplotlib. Some advanced statistical functionality requires scipy and/or statsmodels.

Installation

The latest stable release (and required dependencies) can be installed from PyPI:

uv pip install seaborn

It is also possible to include optional statistical dependencies:

uv pip install seaborn[stats]

Seaborn can also be installed with conda:

conda install seaborn

Note that the main anaconda repository lags PyPI in adding new releases, but conda-forge (-c conda-forge) typically updates quickly.

Citing

A paper describing seaborn has been published in the Journal of Open Source Software. The paper provides an introduction to the key features of the library, and it can be used as a citation if seaborn proves integral to a scientific publication.

Testing

Testing seaborn requires installing additional dependencies; they will be installed when running uv sync with a source checkout.

To test the code, run make test in the source directory. This will exercise the unit tests (using pytest) and generate a coverage report.

Code style is enforced with ruff using the settings in the pyproject.toml file. Run make lint to check. Alternately, you can use pre-commit to automatically run lint checks on any files you are committing: just run pre-commit install to set it up, and then commit as usual going forward.

Development

Seaborn development takes place on Github: https://github.com/mwaskom/seaborn

Please submit bugs that you encounter to the issue tracker with a reproducible example demonstrating the problem. Questions about usage are more at home on StackOverflow, where there is a seaborn tag.

seaborn (mwaskom/seaborn)

pypi
Searching Database…

14.1K ·GitHub
What is this?Seaborn is a Python visualization library based on matplotlib that provides a high-level interface for drawing attractive statistical graphics.
So how is it different from just using matplotlib directly?It is a library you import into your Python code, sitting on top of matplotlib: you get a higher-level API focused on statistical graphics instead of assembling plot details yourself.
What does it need installed besides the library itself?Python 3.10 or newer, plus numpy, pandas, and matplotlib. Advanced statistical functionality additionally needs scipy and/or statsmodels — installable with uv pip install seaborn[stats].
Any pitfalls to know about before installing?If you go the conda route, the main anaconda repository lags PyPI on new releases; the conda-forge channel typically updates quickly.
Where should I start after installing?The online docs at seaborn.pydata.org include a tutorial, an example gallery, an API reference, and an FAQ — the example gallery is a quick way to see what the library can draw.
Does it work with my pandas DataFrames?Yes — pandas is a required dependency, so seaborn is built around pandas data structures rather than asking you to convert your data first.
Is there anything to cite if I use it in research?Yes — a paper describing seaborn was published in the Journal of Open Source Software, and the README offers it as a citation when seaborn is integral to a scientific publication.
Can I use it in commercial projects?Yes — per its GitHub metadata seaborn is distributed under the permissive BSD-3-Clause license, so commercial and scientific use are both fine.
Creator
mwaskom
Size
53.3 MB
Stars
14.1K
Age
14y
Commits · 90 Days