iiasa / message_ix

The integrated assessment and energy systems model MESSAGEix
https://docs.messageix.org
Apache License 2.0
111 stars 149 forks source link

Document mathematical notation #811

Open khaeru opened 3 months ago

khaeru commented 3 months ago

Following on the 2024-03-28 MESSAGE meeting (https://github.com/iiasa/message_ix/pull/388#issuecomment-2024738439), this PR proposes a style of mathematical notation to be used in the docs.

This style is:

This PR is not intended to include revision of all equations to match the style, only to establish it. That revision would be accomplished in 1 or more follow-up PRs by a team of contributors.

How to review

PR checklist

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.4%. Comparing base (1fca82f) to head (f5f7ff6). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #811 +/- ## ===================================== Coverage 95.4% 95.4% ===================================== Files 46 46 Lines 4354 4354 ===================================== Hits 4156 4156 Misses 198 198 ```