CI Pipeline 340699, commit ef367bb

psyplot · Jan 24, 2024 · f15dd32 · f15dd32
1 parent 93136c8
commit f15dd32
Show file tree

Hide file tree

Showing 167 changed files with 8,127 additions and 16,500 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6a3db3c106e5697641d7eeabf8c0c221
+config: 1549664d76fbae11c8df9b45ba3b4393
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/docs-array_frame.png b/_images/docs-array_frame.png
diff --git a/_images/docs-btn_add.png b/_images/docs-btn_add.png
diff --git a/_images/docs-btn_animate_backward.png b/_images/docs-btn_animate_backward.png
diff --git a/_images/docs-btn_animate_forward.png b/_images/docs-btn_animate_forward.png
diff --git a/_images/docs-btn_del.png b/_images/docs-btn_del.png
diff --git a/_images/docs-btn_export.png b/_images/docs-btn_export.png
diff --git a/_images/docs-btn_mpl_pan.png b/_images/docs-btn_mpl_pan.png
diff --git a/_images/docs-btn_mpl_settings.png b/_images/docs-btn_mpl_settings.png
diff --git a/_images/docs-btn_mpl_zoom.png b/_images/docs-btn_mpl_zoom.png
diff --git a/_images/docs-btn_next.png b/_images/docs-btn_next.png
diff --git a/_images/docs-btn_open.png b/_images/docs-btn_open.png
diff --git a/_images/docs-btn_preset.png b/_images/docs-btn_preset.png
diff --git a/_images/docs-btn_prev.png b/_images/docs-btn_prev.png
diff --git a/_images/docs-btn_reload.png b/_images/docs-btn_reload.png
diff --git a/_images/docs-combo_array.png b/_images/docs-combo_array.png
diff --git a/_images/docs-dimension_table.png b/_images/docs-dimension_table.png
diff --git a/_images/docs-ds_tree.png b/_images/docs-ds_tree.png
diff --git a/_images/docs-ds_widget.png b/_images/docs-ds_widget.png
diff --git a/_images/docs-getting-started-btn_cmap.png b/_images/docs-getting-started-btn_cmap.png
diff --git a/_images/docs-getting-started-btn_proj.png b/_images/docs-getting-started-btn_proj.png
diff --git a/_images/docs-getting-started-ds_widget.png b/_images/docs-getting-started-ds_widget.png
diff --git a/_images/docs-getting-started-example.png b/_images/docs-getting-started-example.png
diff --git a/_images/docs-getting-started-t2m.png b/_images/docs-getting-started-t2m.png
diff --git a/_images/docs-lbl_interval.png b/_images/docs-lbl_interval.png
diff --git a/_images/docs-lev-button.png b/_images/docs-lev-button.png
diff --git a/_images/docs-lineplot-btn_add.png b/_images/docs-lineplot-btn_add.png
diff --git a/_images/docs-lineplot-btn_del.png b/_images/docs-lineplot-btn_del.png
diff --git a/_images/docs-lineplot-combo_dims.png b/_images/docs-lineplot-combo_dims.png
diff --git a/_images/docs-lineplot-combo_lines.png b/_images/docs-lineplot-combo_lines.png
diff --git a/_images/docs-lineplot-example.png b/_images/docs-lineplot-example.png
diff --git a/_images/docs-lineplot.png b/_images/docs-lineplot.png
diff --git a/_images/docs-mapplot-btn_cmap.png b/_images/docs-mapplot-btn_cmap.png
diff --git a/_images/docs-mapplot-btn_cmap_settings.png b/_images/docs-mapplot-btn_cmap_settings.png
diff --git a/_images/docs-mapplot-btn_datagrid.png b/_images/docs-mapplot-btn_datagrid.png
diff --git a/_images/docs-mapplot-btn_labels.png b/_images/docs-mapplot-btn_labels.png
diff --git a/_images/docs-mapplot-btn_proj.png b/_images/docs-mapplot-btn_proj.png
diff --git a/_images/docs-mapplot-btn_proj_settings.png b/_images/docs-mapplot-btn_proj_settings.png
diff --git a/_images/docs-mapplot-combo_plot.png b/_images/docs-mapplot-combo_plot.png
diff --git a/_images/docs-mapplot-example.png b/_images/docs-mapplot-example.png
diff --git a/_images/docs-mapplot.png b/_images/docs-mapplot.png
diff --git a/_images/docs-mpl-toolbar.png b/_images/docs-mpl-toolbar.png
diff --git a/_images/docs-navigation.png b/_images/docs-navigation.png
diff --git a/_images/docs-open_widget.png b/_images/docs-open_widget.png
diff --git a/_images/docs-plot2d-example.png b/_images/docs-plot2d-example.png
diff --git a/_images/docs-plot2d.png b/_images/docs-plot2d.png
diff --git a/_images/docs-plot_tabs.png b/_images/docs-plot_tabs.png
diff --git a/_images/docs-sl_interval.png b/_images/docs-sl_interval.png
diff --git a/_images/docs-time-button.png b/_images/docs-time-button.png
diff --git a/_images/docs-variable_frame.png b/_images/docs-variable_frame.png
diff --git a/_images/screenshot.png b/_images/screenshot.png
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_modules/psy_view.html b/_modules/psy_view.html
diff --git a/_modules/psy_view/dialogs.html b/_modules/psy_view/dialogs.html
diff --git a/_modules/psy_view/ds_widget.html b/_modules/psy_view/ds_widget.html
diff --git a/_modules/psy_view/plotmethods.html b/_modules/psy_view/plotmethods.html
diff --git a/_modules/psy_view/rcsetup.html b/_modules/psy_view/rcsetup.html
diff --git a/_modules/psy_view/utils.html b/_modules/psy_view/utils.html
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,13 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _api:
+
+API Reference
+=============
+
+
+.. toctree::
+
+    api/psy_view
diff --git a/_sources/api/psy_view.dialogs.rst.txt b/_sources/api/psy_view.dialogs.rst.txt
@@ -1,6 +1,3 @@
-psy\_view.dialogs module
-========================
-
 .. automodule:: psy_view.dialogs
    :members:
    :undoc-members:

diff --git a/_sources/api/psy_view.ds_widget.rst.txt b/_sources/api/psy_view.ds_widget.rst.txt
@@ -1,6 +1,3 @@
-psy\_view.ds\_widget module
-===========================
-
 .. automodule:: psy_view.ds_widget
    :members:
    :undoc-members:

diff --git a/_sources/api/psy_view.plotmethods.rst.txt b/_sources/api/psy_view.plotmethods.rst.txt
@@ -1,6 +1,3 @@
-psy\_view.plotmethods module
-============================
-
 .. automodule:: psy_view.plotmethods
    :members:
    :undoc-members:

diff --git a/_sources/api/psy_view.rcsetup.rst.txt b/_sources/api/psy_view.rcsetup.rst.txt
@@ -1,6 +1,3 @@
-psy\_view.rcsetup module
-========================
-
 .. automodule:: psy_view.rcsetup
    :members:
    :undoc-members:

diff --git a/_sources/api/psy_view.rst.txt b/_sources/api/psy_view.rst.txt
@@ -1,5 +1,4 @@
-.. _api:
-API Reference
+psy\_view package
 =================
 
 .. automodule:: psy_view

diff --git a/_sources/api/psy_view.utils.rst.txt b/_sources/api/psy_view.utils.rst.txt
@@ -1,6 +1,3 @@
-psy\_view.utils module
-======================
-
 .. automodule:: psy_view.utils
    :members:
    :undoc-members:

diff --git a/_sources/command_line.rst.txt b/_sources/command_line.rst.txt
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
 .. highlight:: bash
 
 .. _command-line:

diff --git a/_sources/contributing.rst.txt b/_sources/contributing.rst.txt
@@ -0,0 +1,10 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _contributing:
+
+Contribution and development hints
+==================================
+
+See :ref:`psyplots contribution guidelines <psyplot:contributing>`.
diff --git a/_sources/getting-started.rst.txt b/_sources/getting-started.rst.txt
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
 .. _getting-started:
 
 Getting started
@@ -56,10 +60,12 @@ like this:
     :suppress:
 
     In [1]: import psyplot.project as psy
+       ...:
        ...: with psy.plot.mapplot(
-       ...:         "demo.nc", name="t2m",
-       ...:         cmap="viridis",
-       ...:     ) as sp:
+       ...:     "demo.nc",
+       ...:     name="t2m",
+       ...:     cmap="viridis",
+       ...: ) as sp:
        ...:     sp.export("docs-getting-started-example.png")
 
 .. image:: docs-getting-started-example.png
@@ -99,4 +105,4 @@ checkout the :ref:`API reference <api>`.
 
 .. |btn_animate_forward| screenshot:: ds_widget.btn_animate_forward docs-btn_animate_forward.png
     :height: 1.3em
-    :enable:
+    :enable:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,109 +1,32 @@
-.. psy-view documentation master file, created by
-   sphinx-quickstart on Wed Jul  8 21:08:22 2020.
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. psy-view documentation master file
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. _psy-view:
-
-Welcome to psy-view!
-====================
-
-.. image:: _static/screenshot.png
-    :width: 50%
-    :alt: GUI screenshot
-    :align: center
+Welcome to psy-view's documentation!
+====================================
 
-*psy-view* defines a viewer application for netCDF files, that is highly
-motivated by the ncview_ software 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.
+|CI|
+|Code coverage|
+|Latest Release|
+|PyPI version|
+|Code style: black|
+|Imports: isort|
+|PEP8|
+|Checked with mypy|
+|REUSE status|
 
-.. _ncview: http://meteora.ucsd.edu/~pierce/ncview_home_page.html
+.. rubric:: ncview-like interface to psyplot
 
 .. warning::
 
-    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].
-
-.. start-badges
-
-.. only:: html and not epub
-
-    .. list-table::
-        :stub-columns: 1
-        :widths: 10 90
-
-        * - docs
-          - |docs| |mybinder|
-        * - tests
-          - |circleci| |appveyor| |codecov|
-        * - package
-          - |version| |conda| |github| |zenodo|
-        * - implementations
-          - |supported-versions| |supported-implementations|
-        * - get in touch
-          - |gitter| |mailing-list| |issues|
-
-    .. |docs| image:: https://img.shields.io/github/deployments/psyplot/psy-view/github-pages
-        :alt: Documentation
-        :target: http://psyplot.github.io/psy-view/
-
-    .. |mybinder| image:: https://mybinder.org/badge_logo.svg
-        :target: https://mybinder.org/v2/gh/psyplot/psy-view/master?urlpath=%2Fdesktop
-        :alt: mybinder.org
-
-    .. |circleci| image:: https://circleci.com/gh/psyplot/psy-view/tree/master.svg?style=svg
-        :alt: CircleCI
-        :target: https://circleci.com/gh/psyplot/psy-view/tree/master
-
-    .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/a7qxvvwt0e41j32h/branch/master?svg=true
-        :alt: AppVeyor
-        :target: https://ci.appveyor.com/project/psyplot/psy-view/branch/master
-
-    .. |codecov| image:: https://codecov.io/gh/psyplot/psy-view/branch/master/graph/badge.svg
-        :alt: Coverage
-        :target: https://codecov.io/gh/psyplot/psy-view
-
-    .. |conda| image:: https://anaconda.org/conda-forge/psy-view/badges/version.svg
-        :alt: conda
-        :target: https://anaconda.org/conda-forge/psy-view
-
-    .. |github| image:: https://img.shields.io/github/release/psyplot/psy-view.svg
-        :target: https://github.com/psyplot/psy-view/releases/latest
-        :alt: Latest github release
-
-    .. |version| image:: https://img.shields.io/pypi/v/psy-view.svg?style=flat
-        :alt: PyPI Package latest release
-        :target: https://pypi.python.org/pypi/psy-view
-
-    .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/psy-view.svg?style=flat
-        :alt: Supported versions
-        :target: https://pypi.python.org/pypi/psy-view
-
-    .. |supported-implementations| image:: https://img.shields.io/pypi/implementation/psy-view.svg?style=flat
-        :alt: Supported implementations
-        :target: https://pypi.python.org/pypi/psy-view
-
-    .. |gitter| image:: https://img.shields.io/gitter/room/psyplot/community.svg?style=flat
-        :target: https://gitter.im/psyplot/community
-        :alt: Gitter
-
-    .. |mailing-list| image:: https://img.shields.io/badge/join-mailing%20list-brightgreen.svg?style=flat
-        :target: https://www.listserv.dfn.de/sympa/subscribe/psyplot
-        :alt: DFN mailing list
-
-    .. |issues| image:: https://img.shields.io/github/issues-raw/psyplot/psy-view.svg?style=flat
-        :target: https://github.com/psyplot/psy-view/issues
-        :alt: GitHub issues
-
-    .. |zenodo| image:: https://zenodo.org/badge/249615633.svg
-        :alt: Zenodo
-        :target: https://zenodo.org/badge/latestdoi/249615633
-
-.. end-badges
+    This page has been automatically generated as has not yet been reviewed by
+    the authors of psy-view!
+    Stay tuned for updates and discuss with us at
+    https://codebase.helmholtz.cloud/psyplot/psy-view
 
 Features
 --------
@@ -119,10 +42,13 @@ Some of the most important features offered by psy-view are:
 
 Interested? Read more in the section :ref:`psy-view-vs-ncview`.
 
-.. _ICON: https://mpimet.mpg.de/en/science/modeling-with-icon/icon-configurations
+.. _ICON: https://code.mpimet.mpg.de/projects/iconpublic
 .. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/
 .. _psyplot-gui: https://psyplot.github.io/psyplot-gui
 
+
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -132,7 +58,8 @@ Interested? Read more in the section :ref:`psy-view-vs-ncview`.
    user-guide
    ncview
    command_line
-   api/psy_view
+   api
+   contributing
    todo
 
 
@@ -155,6 +82,48 @@ information and a guide about good bug reports.
 .. _contribution guide: https://github.com/psyplot/psyplot/blob/master/CONTRIBUTING.md
 
 
+How to cite this software
+-------------------------
+
+.. card:: Please do cite this software!
+
+   .. tab-set::
+
+      .. tab-item:: APA
+
+         .. citation-info::
+            :format: apalike
+
+      .. tab-item:: BibTex
+
+         .. citation-info::
+            :format: bibtex
+
+      .. tab-item:: RIS
+
+         .. citation-info::
+            :format: ris
+
+      .. tab-item:: Endnote
+
+         .. citation-info::
+            :format: endnote
+
+      .. tab-item:: CFF
+
+         .. citation-info::
+            :format: cff
+
+
+License information
+-------------------
+Copyright © 2021-2024 Helmholtz-Zentrum hereon GmbH
+
+The source code of psy-view is licensed under
+LGPL-3.0-only.
+
+If not stated otherwise, the contents of this documentation is licensed under
+CC-BY-4.0.
 
 
 Indices and tables
@@ -163,3 +132,25 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+
+.. |CI| image:: https://codebase.helmholtz.cloud/psyplot/psy-view/badges/main/pipeline.svg
+   :target: https://codebase.helmholtz.cloud/psyplot/psy-view/-/pipelines?page=1&scope=all&ref=main
+.. |Code coverage| image:: https://codebase.helmholtz.cloud/psyplot/psy-view/badges/main/coverage.svg
+   :target: https://codebase.helmholtz.cloud/psyplot/psy-view/-/graphs/main/charts
+.. |Latest Release| image:: https://codebase.helmholtz.cloud/psyplot/psy-view/-/badges/release.svg
+   :target: https://codebase.helmholtz.cloud/psyplot/psy-view
+.. .. TODO: uncomment the following line when the package is published at https://pypi.org
+.. .. |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/
+.. TODO: uncomment the following line when the package is registered at https://api.reuse.software
+.. .. |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
diff --git a/_sources/installing.rst.txt b/_sources/installing.rst.txt
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
 .. _install:
 
 Installation

diff --git a/_sources/ncview.rst.txt b/_sources/ncview.rst.txt
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
 .. _psy-view-vs-ncview:
 
 psy-view vs. ncview
@@ -105,5 +109,5 @@ creating a new issue at https://github.com/psyplot/psy-view/issues/
 .. _PyQt5: https://riverbankcomputing.com/software/pyqt
 .. _cartopy: https://scitools.org.uk/cartopy/docs/latest
 .. _psyplot GUI: https://psyplot.github.io/psyplot-gui/
-.. _ICON: https://mpimet.mpg.de/en/science/modeling-with-icon/icon-configurations
+.. _ICON: https://code.mpimet.mpg.de/projects/iconpublic
 .. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/
diff --git a/_sources/todo.rst.txt b/_sources/todo.rst.txt
@@ -1,6 +1,10 @@
+.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
 .. _todo:
 
 ToDos
 =====
 
-.. todolist::
+.. todolist::