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.

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

update readme and templates to reflect changes in datapipes #120

Merged
merged 6 commits into from
Jan 18, 2024

Conversation

zakwatts
Copy link
Contributor

@zakwatts zakwatts commented Jan 10, 2024

PR mainly of edits to the documentation and template configs.

Commit history is very large and was causing issues when downloading, even with a GitHub buffer size increased to 1Gb I was running into download problems. Hence it has suggested that a clone depth can be used with cloning the repo.

Instructions on how to set up and get started with ocf_datapipes in order to create batches have been added alongside a more step by step guide through where to specify config files and google cloud set up instructions (with gcsfc being adding the requirements.txt)

Recent changes in ocf_datapipes also meant that the example configs were out of date, with multiple NWPs now being used the way the nwps in the config were set up have changed slightly (by an indentation, I believe to reflect it now being a dictionary of NWPs but I have not looked into this too much!)

Copy link

codecov bot commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2c05bc2) 57.76% compared to head (f5400fe) 57.76%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #120   +/-   ##
=======================================
  Coverage   57.76%   57.76%           
=======================================
  Files          26       26           
  Lines        1712     1712           
=======================================
  Hits          989      989           
  Misses        723      723           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zakwatts zakwatts marked this pull request as draft January 10, 2024 18:47
@zakwatts zakwatts changed the title update readme to inform of large commit history update readme and templates to reflect changes in datapipes Jan 10, 2024
@@ -23,3 +23,4 @@ hydra-core
python-dotenv
hydra-optuna-sweeper
rich
gcsfs
Copy link
Contributor

Choose a reason for hiding this comment

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

could you add a comment here, saying that this is only needed when getting data from gcsfs? Or is it needed more now?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's only needed when getting data from gcsfs. I'll add in a comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

thanks

README.md Outdated
- "gs://public-datasets-eumetsat-solar-forecasting/satellite/EUMETSAT/SEVIRI_RSS/v4/2020_nonhrv.zarr"
- "gs://public-datasets-eumetsat-solar-forecasting/satellite/EUMETSAT/SEVIRI_RSS/v4/2021_nonhrv.zarr"
```
Datapipes is currently set up to use 12 channels from the satellite data which is the YEAR_nonhrv.zarr rather than YEAR_hrv.zarr.
Copy link
Member

Choose a reason for hiding this comment

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

11 channels, the 12th is HRV, which is not included in these ones.

Copy link
Member

@dfulu dfulu left a comment

Choose a reason for hiding this comment

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

Great work Zak!

@zakwatts zakwatts marked this pull request as ready for review January 18, 2024 10:12
@zakwatts zakwatts requested a review from jacobbieker January 18, 2024 10:13
Copy link
Member

@jacobbieker jacobbieker left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@zakwatts zakwatts merged commit 8924ddf into main Jan 18, 2024
@dfulu dfulu deleted the readme_clone_depth branch February 29, 2024 11:22
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.

4 participants