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

Expand ‘Reproducibility’ docs page #226

Merged
merged 4 commits into from
Sep 11, 2024
Merged

Expand ‘Reproducibility’ docs page #226

merged 4 commits into from
Sep 11, 2024

Conversation

khaeru
Copy link
Member

@khaeru khaeru commented Sep 5, 2024

  • Merge/consolidate text formerly in doc/repro.rst in message_data.
    • Update and improve text to match current practice.
    • Organize page under the headings "Documentation", "Testing", "Versioning and naming"
  • Add a list and scheme for external model names (closes Add docs page for model names #224)

How to review

PR checklist

  • Continuous integration checks all ✅
  • Add or expand tests; coverage checks both ✅
  • Add, expand, or update documentation.
  • Update doc/whatsnew.

- Update and improve text to match current practice.
- Add a list and scheme for external model names (#224)
@khaeru khaeru added doc Improvements or additions to documentation enh New features or functionality labels Sep 5, 2024
@khaeru khaeru self-assigned this Sep 5, 2024
@khaeru khaeru requested a review from macflo8 September 5, 2024 09:40
@khaeru khaeru changed the title Expand ‘Reproducibilty’ docs page Expand ‘Reproducibility’ docs page Sep 5, 2024
@khaeru
Copy link
Member Author

khaeru commented Sep 5, 2024

@macflo8, requesting your review here as this tries to encapsulate our Slack discussion. Please let me know if there are particular points I made there that should be included here, and where.

@behnam-zakeri, you asked in today's MESSAGE meeting about a list of model names; you can see here the kernel of it, with TODOs to expand over time. Please let me know if this arrangement and the surrounding text are sufficient.

Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.5%. Comparing base (85fe745) to head (6cebe68).
Report is 5 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #226   +/-   ##
=====================================
  Coverage   59.5%   59.5%           
=====================================
  Files        195     195           
  Lines      15491   15491           
=====================================
  Hits        9225    9225           
  Misses      6266    6266           

- Add link to doc/data.
- Unroll 1-item list in "Other code" section.
- Correct link to model-snapshot.
- Link to node and year code lists.
@macflo8
Copy link
Contributor

macflo8 commented Sep 5, 2024

@khaeru Thanks a lot for extending the reproducibility docs. I think it offers clear instructions and explanations on how the users should work with message-ix-models to ensure reproducibility of their modelling work. The most relevant discussion points from the slack discussion are covered well here.
One point that was also discussed in the slack thread is the possible approaches to versioning/documenting of changes in sub-models (model.materials, model.transport etc.) e.g. via separate sub-model specific whatsnew pages. But this is not necessarily directly related to reproducibility, so I guess this can also be covered somewhere else.

doc/repro.rst Outdated Show resolved Hide resolved
doc/repro.rst Outdated Show resolved Hide resolved
doc/repro.rst Outdated Show resolved Hide resolved
Copy link
Member

@glatterf42 glatterf42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though my review wasn't requested, I skimmed the page out of interested and left some notes. All in all, looks good to me, though :)

doc/repro.rst Outdated Show resolved Hide resolved
@khaeru khaeru merged commit 32cb2fd into main Sep 11, 2024
26 checks passed
@khaeru khaeru deleted the issue/224 branch September 11, 2024 09:01
@khaeru khaeru mentioned this pull request Sep 26, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation enh New features or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs page for model names
3 participants