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

Tutorial + API upgrades #192

Merged
merged 62 commits into from
Jan 23, 2024
Merged

Tutorial + API upgrades #192

merged 62 commits into from
Jan 23, 2024

Conversation

Peter9192
Copy link
Collaborator

@Peter9192 Peter9192 commented Nov 24, 2023

This PR represents a massive cleanup and restructuring of springtime.

  • Goal: Emphasize and demonstrate how springtime helps to harmonize data sources and models
  • How: Add tutorial with notebooks to demonstrate which steps are done 'under the hood' during data load in springtime, and how we've adapted existing modelling packages.
  • Side effect: make it easier to use springtime through the API

Changes:

  • Less or no common/shared attributes on the abstract dataset class
  • Distinguish between preprocessing during load of one dataset, and preprocessing on the joined dataframe
  • Models no longer part of recipe or springtime API. Only demonstrate in tutorial/examples.
  • Separate loaders for bbox/point/points instead of separate classes (?)
  • Distinguish between load and raw_load
  • Pydantic V2
  • Much slimmer docs
  • No longer importing R dependencies!
  • Simplify CI: no more calling R and servers, only install springtime python code.

Progress so far:

  • Intro
  • Combining data
  • PEP715
  • NPN - server down
  • PPO
  • Phenocam
  • EOBS
  • Daymet
  • MODIS
  • Modelling intro
  • Clean up & reorganize docs
  • Pydantic V2
  • Remove modelling from src/springtime and recipes
  • (Re)move example recipes
  • Decide on fate of API docs (keep it for now)
  • Update CI

To do in follow up PRs

closes #174
closes #158
closes #156 (no longer planned)
closes #153 (no longer planned)
closes #111
closes #156
closes #188
closes #190
closes #189
closes #187
should close #186
could close #182

@Peter9192 Peter9192 marked this pull request as ready for review January 23, 2024 12:37
@Peter9192
Copy link
Collaborator Author

There's a few remaining issues in the CI, but I'll postpone those to later dedicated issues/PRs. For now, this is good enough and provides a solid basis to build upon. I'm gonna open new issues for the remaining to do's.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment