Skip to content

Commit

Permalink
docs: add required dependencies (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicrie committed Dec 17, 2023
2 parents e2b3276 + ce6b93a commit 7ec694f
Showing 1 changed file with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,48 @@
Installation
------------

The ``xeofs`` package can be installed using either the ``conda`` package manager or ``pip``.
Required Dependencies
~~~~~~~~~~~~~~~~~~~~~

Conda
~~~~~~~~~~~~~~~~~~
The following packages are required dependencies:

If you are using the ``conda`` package manager, installation is recommended via the ``conda-forge`` channel:
**Core Dependencies**

* Python (3.10 or 3.11)
* `numpy <https://www.numpy.org/>`__
* `pandas <https://pandas.pydata.org/>`__
* `xarray <http://xarray.pydata.org/>`__
* `scikit-learn <https://scikit-learn.org/stable/>`__
* `statsmodels <https://www.statsmodels.org/stable/index.html>`__

**For Performance**

* `dask <https://dask.org/>`__
* `numba <https://numba.pydata.org/>`__

**For I/O**

* `netCDF4 <https://unidata.github.io/netcdf4-python/netCDF4/index.html>`__
* `zarr <https://zarr.readthedocs.io/en/stable/>`__
* `xarray-datatree <https://github.com/xarray-contrib/datatree>`__

**Miscellaneous**

* `typing-extensions <https://pypi.org/project/typing-extensions/>`__
* `tqdm <https://tqdm.github.io/>`__

Instructions
~~~~~~~~~~~~

The ``xeofs`` package can be installed using either the `conda <https://conda.io/projects/conda/en/latest/user-guide/getting-started.html>`__
package manager

.. code-block:: bash
conda install -c conda-forge xeofs
PIP
~~~~~~~~~~~~~~~~

Alternatively, you can also install ``xeofs`` using the Python package installer ``pip``:
or the Python package installer `pip <https://pip.pypa.io/en/stable/getting-started/>`__

.. code-block:: bash
pip install xeofs
Make sure to install the package in an appropriate virtual environment to avoid conflicts with other packages or system-wide Python installations.

0 comments on commit 7ec694f

Please sign in to comment.