.. _installation:

************
Installation
************

Installation from conda-forge
-----------------------------

``pyfive`` is available on `conda-forge` and can be installed with either ``conda`` or ``mamba`` (``mamba`` is now the
defaut solver for ``conda`` so might as well just use ``conda``):

.. code-block:: console

    conda install -c conda-forge pyfive

Installation from PyPI
----------------------

``pyfive`` can be installed from PyPI:

.. code-block:: console

    pip install pyfive 

Install from source: conda-mamba environment
--------------------------------------------

Use a Miniconda/Miniforge3 installer to create an environment using
our conda ``environment.yml`` file, download the latest Miniconda3 installer from
the `Miniconda project <https://www.anaconda.com/docs/getting-started/miniconda/install>`_,
install it, then create and activate the ``pyfive`` environment:

.. code-block:: console

    wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
    bash Miniconda3-latest-Linux-x86_64.sh
    (base) conda env create -n pyfive -f environment.yml
    (base) conda activate pyfive

.. note::

    Our dependencies are all from `conda-forge`, ensuring a smooth and reliable installation process.

Installing Pyfive from source
-----------------------------

The installation then can proceed: installing with ``pip`` and installing ``all`` (i.e.
installing the development and test install):

.. code-block:: console

    pip install -e .

After installing, you can run tests via ``pytest -n 2``.

Supported Python versions
-------------------------

We adhere to `Scientific Python SPEC-0 <https://scientific-python.org/specs/spec-0000/>`_ and support the following Python versions:

* 3.10
* 3.11
* 3.12
* 3.13
* 3.14

.. note::

    ``pyfive`` is fully compatible with ``numpy >= 2.0.0``.