Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Repository Structure & Improve Contributor Onboarding #66

Closed
wants to merge 2 commits into from
Closed

Refactor Repository Structure & Improve Contributor Onboarding #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e92eaa7
Add documentation for datasets and maintainers guide
MAYANK12SHARMA Feb 28, 2025
ba0b7c2
Replace tomli with tomllib for Python 3.11 compatibility
MAYANK12SHARMA Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# 🌞 Open Source Solar Forecasting Project – Volunteers Welcome! 🌞

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![ease of contribution: easy](https://img.shields.io/badge/ease%20of%20contribution:%20easy-32bd50)](https://github.com/openclimatefix/ocf-meta-repo?tab=readme-ov-file#how-easy-is-it-to-get-involved)
Expand All @@ -10,6 +13,7 @@
We're building an open-source solar forecasting pipeline to integrate with the OCF's [PVNet](https://github.com/openclimatefix/pvnet) using publicly available data to predict solar generation at the national level, starting with the UK. Eventually, we aim to achieve **global coverage**! 🌍

Tasks include:

- Identifying gridded Numerical Weather Prediction (NWP) datasets.
- Downloading and transforming NWP data into the preferred Zarr format.
- Acquiring solar generation target data via APIs (e.g., PVlive's solar generation and capacity API).
Expand All @@ -18,8 +22,8 @@ Tasks include:

We will begin in the UK to benchmark against OCF results and expand to other countries as the project progresses. 😄


### Basic Usage Examples

```bash
# Archive Met Office UK data for a specific day in zarr format to Hugging Face
open-data-pvnet metoffice archive --year 2023 --month 12 --day 1 --region uk
Expand All @@ -29,11 +33,12 @@ open-data-pvnet metoffice load --year 2023 --month 1 --day 16 --region uk

```

For detailed usage instructions and examples, see our [Getting Started Guide](getting_started.md#command-line-interface-cli).
For detailed usage instructions and examples, see our [Getting Started Guide](docs/getting_started.md#command-line-interface-cli).

## Volunteer Skills/Roles Needed

We are looking for volunteers with the following skills:

- **Data Engineers**: For data acquisition, curation,transformation, and storage.
- **Machine Learning Enthusiasts**: To experiment, train, and evaluate models.
- **Software Developers**: Especially those with Python expertise.
Expand All @@ -44,7 +49,7 @@ We are looking for volunteers with the following skills:

## Getting Started

Ready to dive in? Check out our [Getting Started Guide](getting_started.md) for an introduction to the key concepts and how you can contribute effectively.
Ready to dive in? Check out our [Getting Started Guide](docs/getting_started.md) for an introduction to the key concepts and how you can contribute effectively.

---

Expand All @@ -62,6 +67,7 @@ If you're passionate about **renewable energy, open-source collaboration, and su
---

## GitHub Project

Explore our project board to track progress and tasks: [Open Climate Fix Solar Project Board](https://github.com/orgs/openclimatefix/projects/36)

---
Expand Down Expand Up @@ -92,8 +98,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!


*Part of the [Open Climate Fix](https://github.com/orgs/openclimatefix/people) community.*
_Part of the [Open Climate Fix](https://github.com/orgs/openclimatefix/people) community._

[![OCF Logo](https://cdn.prod.website-files.com/62d92550f6774db58d441cca/6324a2038936ecda71599a8b_OCF_Logo_black_trans.png)](https://openclimatefix.org)

Expand Down
21 changes: 21 additions & 0 deletions docs/datasets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Datasets

Here are links to datasets that might be useful:

- [ARCO-ERA5 Dataset](https://github.com/google-research/arco-era5)
- [DWD Open Data - Numerical Weather Prediction (NWP)](https://opendata.dwd.de/weather/nwp/)
- [UFS Replay Data](https://psl.noaa.gov/data/ufs_replay/)
- MetOffice 2-year rolling archive [Global](https://registry.opendata.aws/met-office-global-deterministic/) and [UK](https://registry.opendata.aws/met-office-uk-deterministic/)
- [MeteoFrance Open Data](https://meteo.data.gouv.fr)
- [NOAA Global Weather Station Data (hourly)](https://www.ncei.noaa.gov/products/global-historical-climatology-network-hourly)


## Citations

- **Met Office UK Deterministic (UKV)2km Dataset**
Met Office UK Deterministic (UKV)2km on a 2-year rolling archive was accessed on `DATE` from [https://registry.opendata.aws/met-office-uk-deterministic](https://registry.opendata.aws/met-office-uk-deterministic).

## License

- **Met Office Datasets**
British Crown copyright 2022-2024, the Met Office, is licensed under [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/).
Loading
Loading