Installation

_images/fig2.jpg

Photo by Robert Wiedemann on Unsplash

Welcome to the easyclimate installation guide! 🚀 We’re excited to help you get started with our powerful climate analysis tool. Follow these simple steps to install easyclimate on your system.

The easyclimate package is currently built and tested for specific platforms due to compatibility and dependency constraints. Below are the supported platforms and notes for users on other systems.

Windows x86-64/AMD64

Windows 10+

Linux x86-64/AMD64

glibc 2.28 or later, including: Debian 10+, Ubuntu 18.10+, Fedora 29+, CentOS/RHEL 8+

These platforms are fully tested, and pre-built wheels (.whl) are available on PyPI for easy installation via following methods:

Using the PyPI package manager:

python -m pip install easyclimate

If you don’t have pip installed, this Python installation guide can guide you through the process.

  1. Install uv

pip install uv

  1. Install easyclimate by uv

uv pip install easyclimate

🛠️ Support is coming soon! Stay tuned for updates—we’re working on it!

You can use PyPI to install the latest unreleased version from GitHub (⚠️ NOT recommended in most situations):

python -m pip install --upgrade git+https://github.com/shenyulu/easyclimate@dev

Note

The commands above should be executed in a terminal. On Windows, use the cmd.exe or the “Anaconda Prompt” app if you’re using Anaconda.

Tip

For users who have difficulty accessing GitHub, we set up a GIT official mirror to access

python -m pip install --upgrade git+https://gitee.com/shenyulu/easyclimate@dev

Warning

Unfortunately, easyclimate currently does NOT officially support macOS, including both Intel-based Macs and Apple Silicon (M-series) Macs.

Python Version Requirement

easyclimate requires Python 3.10 or higher. To check your Python version, run:

python --version

Make sure you’re up to date! 🐍

Tip

See more Status of Python versions.

Dependencies

easyclimate comes with all the necessary dependencies for a smooth experience. Here’s what gets installed:

  • Base requirements: Essential packages for core functionality.

  • Test requirements: Packages needed for running tests.

  • Docs build requirements: Tools for building the documentation.

numpy >= 1.24.3
xarray >= 2025.06.0
geocat.viz
cartopy >= 0.25
xeofs >= 3.0.0
matplotlib
pandas >= 2.2.0
fast-barnes-py
oceans
intel-fortran-rt
dpcpp-cpp-rt
scipy >=1.8.0
statsmodels
geocat-comp
easyclimate-backend >= 2025.12.1
easyclimate-rust >= 2026.1.0
dask
pymannkendall
flox
xarray_regrid
gsw_xarray
pooch
zarr
metpy
tcpypi
netCDF4
seaborn
EMD-signal
pybarnes
rich

numpy >= 1.24.3
xarray >= 2025.06.0
geocat.viz
cartopy >= 0.25
xeofs >= 3.0.0
matplotlib
pandas >= 2.2.0
fast-barnes-py
oceans
intel-fortran-rt
dpcpp-cpp-rt
scipy >=1.8.0
statsmodels
geocat-comp
easyclimate-backend >= 2025.12.1
easyclimate-rust >= 2026.1.0
dask
pymannkendall
flox
xarray_regrid
gsw_xarray
pooch
zarr
metpy
tcpypi
netCDF4
seaborn
EMD-signal
pybarnes
rich

pytest == 9.0.1
pytest-cov == 7.0.0
pytest-mpl == 0.18.0
pytest-xdist
flake8
pre-commit
twine

numpy >= 1.24.3
xarray >= 2025.06.0
geocat.viz
cartopy >= 0.25
xeofs >= 3.0.0
matplotlib
pandas >= 2.2.0
fast-barnes-py
oceans
intel-fortran-rt
dpcpp-cpp-rt
scipy >=1.8.0
statsmodels
geocat-comp
easyclimate-backend >= 2025.12.1
easyclimate-rust >= 2026.1.0
dask
pymannkendall
flox
xarray_regrid
gsw_xarray
pooch
zarr
metpy
tcpypi
netCDF4
seaborn
EMD-signal
pybarnes
rich

sphinx == 8.2.3
recommonmark == 0.7.1
sphinx-markdown-tables == 0.0.17
jupyter-sphinx == 0.5.3
sphinx-inline-tabs == 2023.4.21
sphinx-gallery == 0.19.0
sphinx-autoapi == 3.6.1
sphinx-copybutton == 0.5.2
shibuya == 2026.1.9
sphinx_iconify == 0.3.0
sphinx_design == 0.6.1
snowballstemmer == 3.0.1
python-dotenv == 1.2.2

Building the Documentation

Want to build the documentation yourself? 📚 Follow these steps:

  • Install the docs build requirements listed above.
    pip install -r docs/requirements.txt

  • Go to the docs directory.

  • Run the build script:
    .\build_docs_windows.ps1

    Hint

    On Windows, we’ve included optipng.exe for you! 😉 You might NOT need to install optipng for image optimization.

    ./build_docs_linux.sh

    Hint

    On Linux, you might need to install optipng for image optimization.

    sudo apt-get install optipng

Tip

For more control, you need to clean the build directory, build the HTML documentation, and copy example notebooks.

We hope this guide makes installing easyclimate a breeze! If you have any questions or run into issues, feel free to reach out. Happy climate analyzing! 🌍