RMI-PACTA / r2dii.data

Datasets to Align Financial Markets with Climate Goals
https://rmi-pacta.github.io/r2dii.data
Creative Commons Zero v1.0 Universal
6 stars 6 forks source link

breaking change: explore alternative to handling "real" datasets in this package #303

Open jdhoffa opened 1 year ago

jdhoffa commented 1 year ago

This package currently serves two purposes. 1 - To provide mock data used for CI/CD, testing and demonstration purposes 2 - It contains a few "real" datasets that are actually used in the banks analysis

We should explore if this is actually desirable, and potentially find an alternative path to distribute "real" datasets.

Real datasets include:

Some of these datasets can/ should perhaps be added into the (private) package: pacta.scenario.preparation

Note: this would require equivalent changes in: https://github.com/RMI-PACTA/r2dii.match https://github.com/RMI-PACTA/r2dii.analysis

AB#10166

jdhoffa commented 1 year ago

@cjyetman I know you don't have a lot/ any context on this, but let me know if you have thoughts

cjyetman commented 1 year ago

I've been hoping that we make pacta.scenario.preparation public too, but maybe that's way off from now?

jdhoffa commented 1 year ago

I think unfortunately that's way off. pacta.scenario.preparation contains legit/ real/ genuine scenario data, I don't think we have the ability to host that data publicly.

At some point, perhaps we can remove the data, and just have the prep functions (I am def not against that), but we need a good way of storing and versioning our data first.

Until then, I think a pkg is the best way to keep the small-medium sized "real" datasets (and also make sure we are all using the same central dataset(s))

jdhoffa commented 1 year ago

An, in particular these two datasets are pretty scenario specific anyway: green_or_brown region_isos

The other two we would need to figure out how to store somewhere: sector_classifications iso_codes - We can/ should/ could just depend on your package for this. I'm happy to use that as a dependency

jdhoffa commented 5 months ago

This breaking change is too large given the current r2dii architecture. However it is absolutely important considerations for future iterations of this software.

Tagging as "wontfix"