Installation

fweather depends essentially on Requests and several geospatial libraries. Please, read the instructions below in order to install fweather.

User Installation

The easiest way to install fweather is using pip:

pip install fweather

Conda Environment Installation

If you prefer using Conda, follow these steps to create a dedicated environment and install the necessary dependencies:

1. Create and Activate the Environment

Create a new environment named fweather with Python 3.11:

conda create -n fweather python=3.11 -y
conda activate fweather

2. Install Core and Documentation Dependencies

Install the primary packages from the conda-forge channel:

conda install -c conda-forge \
  numpy \
  gdal \
  tqdm=4.66.4 \
  pyproj \
  shapely \
  requests=2.32.3 \
  rasterio=1.3.11 \
  xarray=2024.3.0 \
  urllib3=2.2.2 \
  pandas=2.2.2 \
  scipy=1.13.1 \
  python-dateutil \
  rioxarray \
  fsspec=2025.9.0 \
  aiohttp=3.12.15 \
  h5netcdf=1.6.4 \
  cfgrib=0.9.15.0 \
  pystac-client \
  build \
  matplotlib \
  sphinx=8.2.3 \
  sphinx-rtd-theme=3.0.2 \
  docutils=0.21.2 \
  pygments=2.19.2 \
  jinja2=3.1.6 \
  babel=2.17.0 \
  certifi=2026.1.4 \
  charset-normalizer=3.4.4 \
  idna=3.11 \
  imagesize=1.4.1 \
  packaging=25.0 \
  snowballstemmer=3.0.1 \
  -y

3. Install Sphinx Extensions via Pip

Some specific documentation plugins should be installed via pip within the conda environment:

pip install \
  "myst-parser>=4.0.0,<4.1" \
  "sphinx-copybutton>=0.5.2,<1.0.0" \
  "sphinx-design>=0.6.1,<0.7" \
  "sphinx-colorschemed-images>=0.2.0" \
  "sphinx-nefertiti==0.9.1" \
  "roman-numerals==4.1.0" \
  "roman-numerals-py==4.1.0"

Development Installation

Clone the Software Repository:

git clone https://github.com/GSansigolo/fweather.git

Go to the source code folder:

cd fweather

Install in development mode:

pip3 install -e .[all]

Note

If you want to create a new Python Virtual Environment without Conda, please, follow this instruction:

1. Create a new virtual environment linked to Python 3.11:

python3.11 -m venv venv

2. Activate the new environment:

source venv/bin/activate

3. Update pip and setuptools:

pip3 install --upgrade pip
pip3 install --upgrade setuptools

Run the Tests

WIP

Build the Documentation

You can generate the documentation based on Sphinx with the following command:

sphinx-build docs/sphinx docs/sphinx/_build/html

The above command will generate the documentation in HTML and it will place it under:

docs/sphinx/_build/html/

You can open the above documentation in your favorite browser, as:

firefox docs/sphinx/_build/html/index.html