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

Test and improve .model.water #93

Open
khaeru opened this issue Mar 6, 2023 · 1 comment
Open

Test and improve .model.water #93

khaeru opened this issue Mar 6, 2023 · 1 comment
Assignees
Labels
water MESSAGEix-Nexus (water) variant

Comments

@khaeru
Copy link
Member

khaeru commented Mar 6, 2023

This is a tracking issue for follow-up items from #88. Create 1 or more PRs and (if necessary to keep discussion organized) issues to address:

  • Add tests to raise coverage to 100%. including testing for the input data (@awais307 )
  • Consider methods for packaging data, e.g. omit some data from the built message-ix-models package, and provide a script to retrieve it from GitHub, Zenodo, or other location(s).
  • Provide link(s) to the GMD manuscript in review or as published. (@awais307 )
  • Rename the CLI from mix-models water-ix to mix-models water (after corresponding change has been made on message_data). (@adrivinca )
  • Adjust the water reporting scripts to work also for sub-annual time steps (@adrivinca )
  • change private_data_path to package_data_path (@adrivinca )
@khaeru khaeru added the water MESSAGEix-Nexus (water) variant label Mar 6, 2023
@khaeru khaeru mentioned this issue Mar 7, 2023
4 tasks
@khaeru khaeru changed the title Improve .model.water Test and improve .model.water Mar 7, 2023
@adrivinca adrivinca assigned adrivinca and awais307 and unassigned adrivinca Mar 7, 2023
@khaeru
Copy link
Member Author

khaeru commented Mar 7, 2023

Consider methods for packaging data, e.g. omit some data from the built message-ix-models package, and provide a script to retrieve it from GitHub, Zenodo, or other location(s).

Just for information here, I tried the following:

$ python setup.py bdist_wheel sdist
  • With the added files in message_ix_models/data/water/, the size of the total (compressed) package is now 2.7 MB.
  • Unpacked, those files are about 10.8 MB.

The fact that you've chosen to handle this data as CSVs rather than binary formats like MS Excel means that it compresses quite well. This is also not a lot compared to other packages (e.g. numpy is 10–20 MB compressed), so my sense is that it is not, for now, worth the effort to invent a more elaborate way of handling this data.

@awais307 awais307 mentioned this issue Jun 19, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
water MESSAGEix-Nexus (water) variant
Projects
None yet
Development

No branches or pull requests

3 participants