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

.. _installation:

Installation
============

Installation using conda
^^^^^^^^^^^^^^^^^^^^^^^^
We highly recommend to use conda_ for installing psy-simple. After downloading
the `miniconda installer`_, you can install psy-simple simply via::

    $ conda install -c conda-forge psy-simple

.. _miniconda installer: https://conda.io/en/latest/miniconda.html
.. _conda: https://docs.conda.io/en/latest/

Installation using pip
^^^^^^^^^^^^^^^^^^^^^^
To install the `psy-simple` package on Linux, we recommend that
you install it from PyPi via::

    pip install psy-simple

Or install it directly from `the source code repository on Gitlab`_ via::

    pip install git+https://codebase.helmholtz.cloud/psyplot/psy-simple.git

The latter should however only be done if you want to access the development
versions.

.. _the source code repository on Gitlab: https://codebase.helmholtz.cloud/psyplot/psy-simple


.. _install-develop:

Installation for development
----------------------------
Please head over to our :ref:`contributing guide <contributing>` for
installation instruction for development.