Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/psyplot/psy-view

An ncview-like GUI with psyplot
https://github.com/psyplot/psy-view

data-science gui netcdf psyplot visualization

Last synced: 12 days ago
JSON representation

An ncview-like GUI with psyplot

Awesome Lists containing this project

README 

        
.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH

..

.. SPDX-License-Identifier: CC-BY-4.0



=========================================

psy-view: An ncview-like GUI with psyplot

=========================================



.. start-badges



|CI|

|Code coverage|

|Latest Release|

|PyPI version|

|Code style: black|

|Imports: isort|

|PEP8|

|Checked with mypy|

|REUSE status|



.. end-badges



This package defines a viewer application for netCDF files, that is highly

motivated by the ncview_ package but entirely built upon the psyplot framework.

It supports strucutured and unstructured grids and provides an intuitive

graphical user interface to quickly dive into the data inside a netCDF file.



.. _ncview: http://meteora.ucsd.edu/~pierce/ncview_home_page.html



**This package is currently under development and we highly appreciate your

feedback! Please try it out yourself and, if you would like to see more features,

find bugs or want to say anything else, please leave your comments and

experiences at https://github.com/psyplot/psy-view/issues or send a mail to

[email protected].**



.. image:: docs/_static/screenshot.png

    :alt: Screenshot

    :target: https://github.com/psyplot/psy-view



Features

--------

Some of the most important features offered by psy-view are:



- intuitive GUI to select variables, dimensions, slices, etc. and change the

  plot

- automatically decodes CF-conventions and supports unstructured grid, such as

  ICON_ or UGRID_

- animation interface

- different projections

- implemented in psyplot-gui_ for full flexibility (if desired)



.. _ICON: https://code.mpimet.mpg.de/projects/iconpublic

.. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/

.. _psyplot-gui: https://psyplot.github.io/psyplot-gui



Test it without installation

----------------------------

You can try the functionalities with some selected example files headless in

your browser by clicking on |mybinder|. Note that it might take a bit to load

and that the speed depends on your WiFi-connection.



Installation

------------

To install the current work-in-progress, please



1. download Miniconda_

2. open the terminal (or `Anaconda Prompt` on Windows) and type::



      conda create -n psyplot -c conda-forge psy-view



   On Linux and OS X, you may instead want to type::



      $ conda create -n psyplot -c conda-forge --override-channels psy-view



   in order to not mix the anaconda defaults and and conda-forge channel, because

   mixing them can sometimes cause incompatibilities.

3. The commands above will installed psy-view and all it's necessary

   dependencies into a separate environment. You can activate it via::



      conda activate psyplot



4. Now launch the GUI via typing::



      psy-view



  or::



      psy-view 



   See ``psy-view --help`` for more options



.. _Miniconda: https://conda.io/en/latest/miniconda.html



As an alternativ to a local installation, you can also run it

headless in you browser by clicking |mybinder|



For alternative installation instructions, update information or deinstallation

instructions, please have a look into the `installation docs`_.



.. _installation docs: https://psyplot.github.io/psy-view/installing.html



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 `channel on gitter`_

- 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.



.. _bug tracker: https://github.com/psyplot/psy-view

.. _channel on gitter: https://gitter.im/psyplot/community

.. _mailing list: https://www.listserv.dfn.de/sympa/subscribe/psyplot

.. _code of conduct: https://github.com/psyplot/psyplot/blob/master/CODE_OF_CONDUCT.md

.. _contribution guide: https://github.com/psyplot/psyplot/blob/master/CONTRIBUTING.md



Copyright disclaimer

--------------------

Copyright (C) 2020 Philipp S. Sommer



This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.



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 General Public License for more details.



You should have received a copy of the GNU General Public License

along with this program.  If not, see https://www.gnu.org/licenses/.



.. |CI| image:: https://codebase.helmholtz.cloud/psyplot/psy-view/badges/master/pipeline.svg

   :target: https://codebase.helmholtz.cloud/psyplot/psy-view/-/pipelines?page=1&scope=all&ref=master

.. |Code coverage| image:: https://codebase.helmholtz.cloud/psyplot/psy-view/badges/master/coverage.svg

   :target: https://codebase.helmholtz.cloud/psyplot/psy-view/-/graphs/master/charts

.. |Latest Release| image:: https://codebase.helmholtz.cloud/psyplot/psy-view/-/badges/release.svg

   :target: https://codebase.helmholtz.cloud/psyplot/psy-view

.. |PyPI version| image:: https://img.shields.io/pypi/v/psy-view.svg

   :target: https://pypi.python.org/pypi/psy-view/

.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

   :target: https://github.com/psf/black

.. |Imports: isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336

   :target: https://pycqa.github.io/isort/

.. |PEP8| image:: https://img.shields.io/badge/code%20style-pep8-orange.svg

   :target: https://www.python.org/dev/peps/pep-0008/

.. |Checked with mypy| image:: http://www.mypy-lang.org/static/mypy_badge.svg

   :target: http://mypy-lang.org/

.. |REUSE status| image:: https://api.reuse.software/badge/codebase.helmholtz.cloud/psyplot/psy-view

   :target: https://api.reuse.software/info/codebase.helmholtz.cloud/psyplot/psy-view