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

The following instructions will allow you to install PyIRI.

Prerequisites
-------------

PyIRI uses the Python modules included in the list below. This module
officially supports Python 3.10+.

1. fortranformat
2. matplotlib
3. netCDF4
4. numpy
5. opt_einsum
6. scipy


Installation Options
--------------------

1. Clone the git repository
::


   git clone https://github.com/victoriyaforsythe/PyIRI.git


2. Install PyIRI:
   Change directories into the repository folder and build the project.
   There are a few ways you can do this:

   A. Install on the system (root privileges required)::


        sudo pip install .

   B. Install at the user level::


        pip install --user .

   C. Install with the intent to change the code::


        pip install --user -e .

Optional Requirements
---------------------

To run the test suite and build the documentation locally, you also need the
following Python packages.

.. extras-require:: test
    :pyproject:

.. extras-require:: doc
    :pyproject: