Skip to content

Conversation

@cofinoa
Copy link
Member

@cofinoa cofinoa commented Nov 5, 2025

This pull request updates the main README.md to reflect the current structure of the Climate4R ecosystem and the introduction of the new climate4r-meta metapackage.

Summary of changes

  • Clarifies that climate4r-meta is now the official entry point for installation (r-climate4r via conda-forge).
  • Simplifies and restructures the documentation in this repository to serve as the main reference and overview for the Climate4R framework.
  • Converts all absolute GitHub URLs into GitHub-flavored Markdown references (e.g. SantanderMetGroup/repo, #issue).
  • Cleans up duplicated installation instructions and outdated details.
  • Keeps developer-oriented instructions for reproducibility and legacy notebooks.

Rationale

This update reduces confusion between the original climate4R repository and the new climate4r-meta package repository.
It also modernizes the README and aligns it with the organization’s documentation style across Climate4R repositories.

Next steps

Once merged into devel, the README can be synced to main before pinning the repository on the organization page, ensuring users see the updated entry point.

Updated the README to improve clarity and detail about the Climate4R framework, including package descriptions and installation instructions.
- Updated README to clarify the new structure of the Climate4R ecosystem
- Introduced references to the metapackage climate4r-meta
- Replaced absolute GitHub URLs with GitHub-flavored Markdown links
- Cleaned and reorganized sections for clarity (overview, installation, examples, support)
- Removed outdated details and redundant instructions
@cofinoa cofinoa requested review from a team, anacv, jbedia, jesusff and miturbide November 5, 2025 19:02
@cofinoa
Copy link
Member Author

cofinoa commented Nov 5, 2025

Opening this as a full PR so everyone can review and comment, no need to merge right away.
It’s mostly a documentation update to align the README with the new `climate4r-meta structure and improve clarity.

Copy link
Member

@jbedia jbedia left a comment

Choose a reason for hiding this comment

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

perfecto, gracias por el update @cofinoa

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