Skip to content

doc: Add note on SARAH cutout creation#1735

Merged
euronion merged 1 commit intomasterfrom
doc-fixes
Jul 7, 2025
Merged

doc: Add note on SARAH cutout creation#1735
euronion merged 1 commit intomasterfrom
doc-fixes

Conversation

@euronion
Copy link
Copy Markdown
Contributor

@euronion euronion commented Jul 4, 2025

Closes # (if applicable).

Changes proposed in this Pull Request

Checklist

  • [n/a] I tested my contribution locally and it works as intended.
  • [n/a] Code and workflow changes are sufficiently documented.
  • [n/a ] Changed dependencies are added to envs/environment.yaml.
  • [n/a] Changes in configuration options are added in config/config.default.yaml.
  • Changes in configuration options are documented in doc/configtables/*.csv.
  • [n/a] Sources of newly added data are documented in doc/data_sources.rst.
  • [n/a] A release note doc/release_notes.rst is added.

Copilot AI review requested due to automatic review settings July 4, 2025 09:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation for setting up SARAH-based cutouts in atlite and fixes a typo in the existing features description.

  • Fixed typo in the features parameter description (inlfuxinflux).
  • Added a new sarah_dir parameter to the atlite configuration table.
  • Updated config/config.default.yaml with commented placeholders for features and sarah_dir.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
doc/configtables/atlite.csv Correct typo in features description and add sarah_dir parameter documentation.
config/config.default.yaml Insert commented placeholders for the new features and sarah_dir options.
Comments suppressed due to low confidence (3)

doc/configtables/atlite.csv:15

  • [nitpick] Consider adding a concrete example in the CSV example column (e.g., /path/to/sarah_data) to clarify the expected format of sarah_dir.
-- -- sarah_dir,,str,"Path to the location where SARAH-2 or SARAH-3 data is stored; SARAH data requires a manual separate download, see the https://atlite.readthedocs.io for details. Required for building cutouts with SARAH, not required for ERA5 cutouts."

config/config.default.yaml:147

  • A new sarah_dir option has been introduced but there are no tests covering SARAH-based cutout creation; consider adding unit tests to verify that sarah_dir is correctly parsed and used.
      # sarah_dir: ""

config/config.default.yaml:146

  • [nitpick] Commented config placeholders may drift out of sync—consider integrating these defaults into the schema or auto-generating them from doc/configtables/atlite.csv to reduce duplication.
      # features: [] 

@euronion euronion merged commit cc096eb into master Jul 7, 2025
8 checks passed
@euronion euronion deleted the doc-fixes branch July 7, 2025 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants