Improve modules with pragmatic standards and best practices. - Githubissues

calliope-project / ec_modules

Make energy model workflows easy as 🥧!

https://ec-modules.readthedocs.io

MIT License

1 stars 0 forks source link

Improve modules with pragmatic standards and best practices. #14

Open irm-codebase opened 1 month ago

irm-codebase commented 1 month ago

This issue is inspired by comments made by @FraSanvit during the Hydro PR review (#12).

We want pragmatic standards that allow us to avoid issues down the line. Here are some that come out until now.

Documentation

[x] We need to document how to integrate modules together. This should be in the example module, so that people can just copy/paste it when developing something new.
- [x] snakamake profile should be there.

Naming conventions:

[x] We should decide if we use underscores or hyphen/underscore and where to avoid mixups.

Structure:

[x] Results folder structure. We should agree on a shared view of how/where to place results files to make parsing the results easier.

irm-codebase commented 2 weeks ago

This has been added in #39 as part of the new IO standard, with updated documentation.