.. SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
..
.. SPDX-License-Identifier: CC-BY-4.0

.. psyplot-gui documentation master file
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to psyplot-gui's documentation!
=======================================

|CI|
|Code coverage|
|Latest Release|
|PyPI version|
|Code style: black|
|Imports: isort|
|PEP8|
|REUSE status|

.. rubric:: Graphical user interface for the psyplot package

Welcome! This package enhances the interactive visualization framework
psyplot_ with a graphical user interface using PyQt_. See the homepage of the
main project on examples on the possibilities with psyplot_.

.. _PyQt: https://riverbankcomputing.com/software/pyqt/intro
.. _psyplot: https://psyplot.github.io/psyplot/

.. toctree::
    :maxdepth: 1

    installing
    getting_started
    configuration
    command_line
    plugins
    contributing
    api
    changelog
    todos


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 psyplot-gui 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
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. |CI| image:: https://codebase.helmholtz.cloud/psyplot/psyplot-gui/badges/master/pipeline.svg
   :target: https://codebase.helmholtz.cloud/psyplot/psyplot-gui/-/pipelines?page=1&scope=all&ref=master
.. |Code coverage| image:: https://codebase.helmholtz.cloud/psyplot/psyplot-gui/badges/master/coverage.svg
   :target: https://codebase.helmholtz.cloud/psyplot/psyplot-gui/-/graphs/master/charts
.. |Latest Release| image:: https://codebase.helmholtz.cloud/psyplot/psyplot-gui/-/badges/release.svg
   :target: https://codebase.helmholtz.cloud/psyplot/psyplot-gui
.. |PyPI version| image:: https://img.shields.io/pypi/v/psyplot-gui.svg
   :target: https://pypi.python.org/pypi/psyplot-gui/
.. |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/
.. |REUSE status| image:: https://api.reuse.software/badge/codebase.helmholtz.cloud/psyplot/psyplot-gui
   :target: https://api.reuse.software/info/codebase.helmholtz.cloud/psyplot/psyplot-gui