.. _getting-started:

Getting Started
===============

**Install ``cassiopy`` with pip**

``cassiopy`` is available on the `python package index (pypi) <https://pypi.org/project/cassiopy/>`_ as *cassiopy*:

.. code-block:: bash

   $ pip install cassiopy

In order to check that the installation was successful, you can run the following command:

.. code-block:: bash

   $ pip show cassiopy # show cassiopy location and version

The minimum version requirement for ``python`` is ``3.9``.
In addition, you can now import the ``cassiopy`` ``python`` package.

.. code-block:: python

   import cassiopy