forked from xarray-contrib/xeofs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add required dependencies (xarray-contrib#138)
- Loading branch information
Showing
1 changed file
with
34 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |