Make catalog.py, config.py and io.py their own package

Ouranosinc / xscen

A climate change scenario-building analysis framework.

https://xscen.readthedocs.io/

Apache License 2.0

15 stars 2 forks source link

Make catalog.py, config.py and io.py their own package #153

Closed RondeauG closed 1 year ago

RondeauG commented 1 year ago

Addressing a Problem?

These 3 scripts do a lot of useful things that go beyong xscen. They ould be moved to their own repo/package, and simply be imported by xscen.

Potential Solution

No response

Additional context

No response

Contribution

[ ] I would be willing/able to open a Pull Request to contribute this feature.

RondeauG commented 1 year ago

Or not... Compare to functions in miranda and assess who copies who and which ones should be merged.

Zeitsperre commented 1 year ago

I still don't think it's a terrible idea to make these into a helper package. This is a pretty standard approach for libraries that produced by the same organization (e.g. https://github.com/roocs/roocs-utils).

We wouldn't be the first to consider doing this either...

RondeauG commented 1 year ago

Following our discussions last week and here, this issue can be closed.

miranda keeps:
- Downloads and APIs
- convert
- validation (CV, facets)
- frequency & xrfreq dictionnaries
xscen keeps:
- IO, config, scripting
- frequency & xrfreq dictionnaries
xscen gains those from miranda:
- structure: Building the Ouranos folder structure based on facets
- decode: To be replaced by a ‘parse_directory’ workflow

The specific workflows (e.g. download ERA5, convert and validate, then move the files to the correct folder structure) will move to a private repo.

Zeitsperre commented 1 year ago

It might be worthwhile to create a "project" under xscen and open issues in the affected repositories, associating them to the project.

Zeitsperre commented 1 year ago

Issues are now listed on miranda side. Closing.