The psyplot interactive visualization framework

docs
tests
package
implementations
get in touch

Welcome! psyplot is an open source python project that mainly combines the plotting utilities of matplotlib and the data management of the xarray package. The main purpose is to have a framework that allows a fast, attractive, flexible, easily applicable, easily reproducible and especially an interactive visualization of your data.

The ultimate goal is to help scientists and especially climate model developers in their daily work by providing a flexible visualization tool that can be enhanced by their own visualization scripts. psyplot can be used through the python command line and through the psyplot-gui module which provides a graphical user interface for an easier interactive usage.

The package is very new and there are many features that will be included in the future. So we are very pleased for feedback! Please simply raise an issue on GitHub (see also How to contribute in the docs).

You can see the full documentation on psyplot.github.io/psyplot.

Get in touch

Any quesions? Do not hessitate to get in touch with the psyplot developers.

• Create an issue at the bug tracker
• Chat with the developers in out team on mattermost
• Subscribe to the mailing list and ask for support
• Sent a mail to [email protected]

See also the code of conduct, and our contribution guide for more information and a guide about good bug reports.

How to cite psyplot

When using psyplot, you should at least cite the publication in the Journal of Open Source Software:

Sommer, P. S.: The psyplot interactive visualization framework, The Journal of Open Source Software, 2, doi:10.21105/joss.00363, https://doi.org/10.21105/joss.00363, 2017.

Furthermore, each release of psyplot and it's subprojects is associated with a DOI using zenodo.org. If you want to cite a specific version or plugin, please refer to the releases page of psyplot or the releases page of the corresponding subproject.

Acknowledgment

This package is being developed by Philipp S. Sommer at the Helmholtz Coastal Data Center (HCDC) of the Helmholtz-Zentrum Hereon.

I want to thank the developers of the matplotlib, xarray and cartopy packages for their great packages and of course the python developers for their fascinating work on this beautiful language.

A special thanks to Stefan Hagemann and Tobias Stacke from the Max-Planck-Institute of Meteorology in Hamburg, Germany for the motivation on this project and to the people of the Not yet visible agency for their advice in designing the logo and webpage.

Finally the author thanks the Swiss National Science Foundation (SNF) for their support. Funding for the author came from the ACACIA grant (CR10I2_146314) and the HORNET grant (200021_169598).

Note

Commits on github prior to version 1.0 were moved into another repository, the psyplot_old repository. This has been done because prior to version 1.0, the github repository contained all the reference figures used for testing which made the size of the repository too large.

Copyright

Copyright © 2021 Helmholtz-Zentrum Hereon, 2020-2021 Helmholtz-Zentrum Geesthacht, 2016-2021 University of Lausanne

psyplot is released under the GNU LGPL-3.O license. See COPYING and COPYING.LESSER in the root of the repository for full licensing details.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3.0 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU LGPL-3.0 license for more details.

You should have received a copy of the GNU LGPL-3.0 license along with this program. If not, see https://www.gnu.org/licenses/.