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

Choose one installation method and follow it from start to finish.

Requirements
------------

Before installing CaliBrain, make sure that:

- you have Python ``3.10`` or newer;
- you have ``pip`` if you want to install from PyPI or from a local checkout;
- you have ``conda`` if you want to create the repository environment.

Which method should I use?
--------------------------

- :doc:`PyPI <pypi_installation>` if you want the latest released package and
  do not need to modify the source code.
- :doc:`pip <pip_installation>` if you want to install CaliBrain from a local
  repository checkout.
- :doc:`conda <conda_installation>` if you want to create the environment
  defined by the repository ``environment.yml`` file.

Installation methods
--------------------

CaliBrain is documented through three installation paths:

- :doc:`PyPI <pypi_installation>` for installing a published release into an existing Python environment;
- :doc:`pip <pip_installation>` for installing directly from a local source checkout;
- :doc:`conda <conda_installation>` for creating the repository environment defined in ``environment.yml``.

.. toctree::
   :hidden:

   pypi_installation
   pip_installation
   conda_installation