community-forcing-service 0.1.0__tar.gz

community_forcing_service-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: A fetch failed, returned wrong values, or something else broke
+labels: bug
+---
+
+## What happened
+
+A clear description of the problem.
+
+## How to reproduce
+
+```python
+# Minimal example — product ID, bbox, time range, variables
+```
+
+- **Product ID** (e.g. `era5_arco:single_levels`):
+- **Bounding box** (`min_lon,min_lat,max_lon,max_lat`):
+- **Time range**:
+- **Credentials involved?** (CDS / Earthdata / AWS — never paste them):
+
+## What you expected
+
+## Output
+
+Full traceback, or the `FetchResult` (especially `warnings`) if the fetch
+succeeded but the values look wrong.
+
+```
+paste here
+```
+
+## Environment
+
+- CFS version (`cfs --version`):
+- Python version / OS:
+- Install extras used (`climate`, `cds`, `earthdata`, `forecast`):

community_forcing_service-0.1.0/.github/ISSUE_TEMPLATE/connector_request.md

@@ -0,0 +1,39 @@
+---
+name: Connector request
+about: Propose a new forcing product for CFS
+labels: connector
+---
+
+## Product
+
+- **Name** (e.g. "NOAA CFSR"):
+- **Provider / archive** (who hosts it):
+- **Access** (cloud Zarr, OPeNDAP, S3 NetCDF/GRIB2, HTTP, CDS API, ...):
+- **URL of the store or landing page**:
+
+## Coverage
+
+- **Spatial domain + resolution**:
+- **Temporal extent + resolution**:
+- **Grid** (regular lat/lon, or projected/rotated — which projection?):
+
+## Variables
+
+Which canonical variables can it supply (air_temperature,
+precipitation_flux, winds, humidity, pressure, SW/LW radiation)?
+Note anything tricky: accumulated precip/radiation, RH instead of
+specific humidity, scalar wind speed only, unusual units.
+
+## Auth and license
+
+- **Authentication** (anonymous, Earthdata, CDS, API key, ...):
+- **Data license**:
+
+## Why
+
+One or two sentences on the modeling use case this unlocks
+(region, period, resolution that existing connectors don't cover).
+
+Willing to implement it yourself? See
+[CONTRIBUTING.md](https://github.com/DarriEy/CFS/blob/main/CONTRIBUTING.md)
+for the connector pattern — PRs welcome.

community_forcing_service-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+## What
+
+One or two sentences: what does this PR change and why?
+
+## Type
+
+- [ ] New connector
+- [ ] Bug fix
+- [ ] Docs / infrastructure
+- [ ] Other
+
+## Verification
+
+- [ ] `ruff check src/ tests/` passes
+- [ ] `mypy src/cfs` passes
+- [ ] `pytest -m "not network"` passes
+- [ ] New code has offline tests (synthetic data; no network)
+
+For connectors: describe what you verified against the live store —
+bbox/period fetched, and whether the returned values look physical
+(temperatures in K, precip flux ~1e-4 not ~10, radiation W m-2).
+
+## Checklist (connectors only)
+
+- [ ] Stops at the canonical dataset (no HRU remapping, no model schemas)
+- [ ] Precip/radiation returned as rates, never accumulations
+- [ ] `VariableMapping` table with unit conversions; ends with `self._finalize(...)`
+- [ ] Added to `inventory/providers.yaml` and `docs/catalog.md`

community_forcing_service-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        # The 'climate' extra (xarray/zarr/s3fs/h5py/...) plus 'cds'/'earthdata'
+        # (cdsapi/pydap/pyproj) ensures the offline tests run for real rather than
+        # being skipped via pytest.importorskip.
+        run: pip install -e ".[climate,cds,earthdata,dev]"
+
+      - name: Lint
+        run: ruff check src/ tests/
+
+      - name: Type check
+        run: mypy src/cfs
+
+      - name: Test (offline only — network tests need credentials/access)
+        run: pytest tests/ -v --tb=short -m "not network" --cov=cfs --cov-report=term

community_forcing_service-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "src/cfs/**"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment; don't cancel an in-progress run.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install docs dependencies
+        run: pip install -e ".[docs]"
+      - name: Build site
+        run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

community_forcing_service-0.1.0/.gitignore

@@ -0,0 +1,29 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+*.tif
+*.tiff
+*.nc
+.env
+.venv/
+venv/
+
+# Claude Code harness (session-local)
+.claude/
+
+# mkdocs build output
+site/
+
+# probe / scratch
+probe_*.py
+.probe_results.txt

community_forcing_service-0.1.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — 2026-06-11
+
+Initial release.
+
+### Added
+
+- **33 forcing connectors** (31 live-verified against their upstream stores;
+  `mswep` and `em_earth` offline-verified pending access/credentials), spanning
+  global and regional reanalyses (ERA5/ERA5-Land, MERRA-2, CARRA, CERRA, RDRS,
+  BARRA2, CONUS404, NARR, WFDE5), analysis products (AORC, NLDAS, HRRR, NWM
+  operational, Daymet, gridMET, nClimGrid-Daily, GLDAS, FLDAS), satellite and
+  station precipitation/temperature (CHIRPS, CHIRTS, GPM IMERG, PERSIANN-CDR,
+  CMORPH, MSWEP, EM-Earth, E-OBS), forecasts (GFS deterministic, GEFS ensemble
+  with a `member` dimension), and climate projections (NEX-GDDP-CMIP6,
+  NA-CORDEX).
+- **Canonical harmonization (`canonical-v1`)**: every connector renames native
+  variables to CF-aligned canonical names and converts to canonical SI units
+  (`cfs.core.vocabulary`); precipitation and radiation are always returned as
+  rates (fluxes), never accumulations.
+- **Subsetting**: bounding-box + time-range subsetting for regular lat/lon
+  grids (`cfs.subset.bbox`, antimeridian-safe) and 2-D/projected grids
+  (`cfs.subset.grid2d` — rotated-pole, Lambert conformal).
+- **Reset-aware de-accumulation** (`cfs.subset.deaccumulate`) for running-total
+  fields (e.g. ERA5-Land `tp`/`ssrd`/`strd`), plus bucket-aware de-accumulation
+  for GEFS 6-hour precipitation/radiation buckets.
+- **Derived variables** (`cfs.derive`): specific humidity from 2 m relative
+  humidity, temperature, and pressure (Bolton 1980) — used by CARRA, CERRA,
+  and GEFS.
+- **Range QC** (`cfs.qc`): advisory physical-range checks on every fetch,
+  reported in `FetchResult.warnings`, catching unit-conversion errors before
+  they reach a model.
+- **Fetch guardrails**: bbox-area (`CFS_MAX_AREA_DEG2`) and cell-count
+  (`CFS_MAX_CELLS_PER_FETCH`) limits enforced uniformly on the connector base
+  class.
+- **CLI** (`cfs providers`, `cfs products`, `cfs fetch`) and an in-process
+  Python API (`discover()` / `get_connector()` / `fetch()`).
+- Protocol mixins for cloud Zarr, OPeNDAP (Earthdata URS), CDS API, HTTP
+  byte-range NetCDF/GRIB2, and rclone.
+
+[0.1.0]: https://github.com/DarriEy/CFS/releases/tag/v0.1.0

community_forcing_service-0.1.0/CITATION.cff

@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using the metadata below."
+type: software
+title: "CFS: Community Forcing Service"
+abstract: >-
+  CFS provides a single asynchronous interface to 33 meteorological forcing
+  products for hydrological and land-surface modelling, acquiring, subsetting,
+  and harmonizing each to a canonical CF-aligned xarray dataset.
+authors:
+  - family-names: Eythorsson
+    given-names: Darri
+    email: dae5@hi.is
+    orcid: "https://orcid.org/0000-0003-3653-3936"
+    affiliation: "University of Calgary"
+repository-code: "https://github.com/DarriEy/CFS"
+license: MIT
+version: 0.1.0
+date-released: "2026-06-11"
+keywords:
+  - hydrology
+  - meteorological forcing
+  - reanalysis
+  - xarray
+  - climate data

community_forcing_service-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dae5@hi.is. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

community_forcing_service-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to CFS
+
+Thanks for your interest in improving the Community Forcing Service. Bug
+reports, new connectors, and documentation fixes are all welcome.
+
+## Development setup
+
+```bash
+git clone https://github.com/DarriEy/CFS.git
+cd CFS
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[climate,cds,earthdata,forecast,dev]"
+```
+
+The `climate` extra (xarray/zarr/s3fs/dask/netcdf4) is required for almost all
+of the test suite; `cds`, `earthdata`, and `forecast` let the provider-specific
+offline tests run for real instead of being skipped.
+
+## Running the tests
+
+```bash
+pytest -m "not network"    # offline tests — no credentials or network needed
+pytest -m network          # integration tests against live stores (optional)
+```
+
+All offline tests must pass before a PR is merged. Network tests hit real
+upstream stores and may need credentials (CDS, Earthdata) — they are not run
+in CI.
+
+## Linting
+
+```bash
+ruff check src/ tests/
+```
+
+CI enforces `ruff` (and `mypy src/cfs`); please run both locally before
+pushing.
+
+## Adding a connector
+
+Connectors are the most valuable contribution. The pattern:
+
+1. **Subclass `BaseForcingConnector`** in a new module under
+   `src/cfs/connectors/` (optionally mix in a protocol helper such as
+   `ZarrStoreMixin`, the Earthdata OPeNDAP mixin, or the CDS API mixin from
+   `cfs.connectors.protocols`).
+2. **Implement `list_products()`** — the catalog metadata: product IDs
+   (`{slug}:{product}`), variables, resolution, bbox, temporal extent,
+   license, and citation.
+3. **Implement `fetch()`** — acquire the upstream data, subset to the
+   requested bbox + time range, then harmonize.
+4. **Declare a `VariableMapping` table** mapping native variable names to
+   canonical variables (`cfs.core.vocabulary.CanonicalVar`) with linear unit
+   conversions (`canonical = source * scale + offset`), setting
+   `deaccumulate=True` for running-total fields.
+5. **Decorate the class with `@register("slug")`** from `cfs.core.registry`;
+   `discover()` finds it automatically — no central list to edit.
+6. **Finish with `self._finalize(...)`** so the shared guardrails and range QC
+   apply uniformly, and return `(dataset, FetchResult)`.
+
+Ground rules:
+
+- The connector **stops at the canonical dataset**: no HRU remapping, no
+  model-specific schemas, no serialization. That is the consumer's job.
+- Precipitation and radiation must be returned as **rates** (`kg m-2 s-1`,
+  `W m-2`), never accumulations.
+- Return **lazy** (dask-backed) datasets where the protocol allows, so the
+  caller decides when to materialize.
+- Add an **offline test** (`tests/test_<slug>_offline.py`) that exercises the
+  mapping/subsetting logic with synthetic data, and a `network`-marked test if
+  a live fetch is feasible.
+- Add the provider to `inventory/providers.yaml` and the docs
+  [provider catalog](docs/catalog.md).
+- If the new product's name collides with an existing acronym (looking at you,
+  NOAA CFS), pick a disambiguated slug.
+
+## Pull requests
+
+- Keep PRs focused — one connector or one fix per PR.
+- Describe what was verified: offline tests only, or a live fetch (where, what
+  values, do they look physical?).
+- CI must be green (ruff, mypy, offline tests on Python 3.11–3.13).
+
+## Questions / bugs
+
+Open an issue at <https://github.com/DarriEy/CFS/issues>. For bugs, include
+the product ID, bbox, time range, and the full traceback or `FetchResult`
+warnings.

community_forcing_service-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Darri Eythorsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.