Group python components into installable package - Githubissues

leap-stc / ClimSim

An open large-scale dataset for training high-resolution physics emulators in hybrid multi-scale climate simulators.

https://leap-stc.github.io/ClimSim/

Apache License 2.0

138 stars 40 forks source link

Group python components into installable package #16

Closed cisaacstern closed 1 year ago

cisaacstern commented 1 year ago

Closes #14 when complete

cisaacstern commented 1 year ago

Completed:

[x] data_utils is now installable with pip install . and can then be imported with from climsim_utils.data_utils import data_utils
[x] added basic smoke test for importability, and run that test in CI
[x] 🎉 tests pass in CI! https://github.com/leap-stc/ClimSim/actions/runs/5896732534/job/15995137882?pr=16
[x] update data_utils import in preprocessing notebook

TODO (for this PR):

[x] update data_utils import in all other notebooks
[x] delete unused data_utils symlinks
[x] Document how to install package in README (pip install . from repo root)