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

Improve documentation of share constraints #876

Open
glatterf42 opened this issue Sep 11, 2024 · 0 comments
Open

Improve documentation of share constraints #876

glatterf42 opened this issue Sep 11, 2024 · 0 comments
Labels
docs Documentation

Comments

@glatterf42
Copy link
Member

What is this about?

As discovered through #875, our documentation for share constraints is lacking. For starters, map_shares_commodity_share and map_shares_commodity_total are missing in the documentation. They are mentioned here, but not explained: what can you do with them, what do their index sets mean? In particular, what does node_share mean and how does it contrast with node? And by defining these in the map_*s, why does e.g. share_commodity_lo need another node_share dimension?

In addition, the index dimensions listed for share_* parameters are erroneous: they reference node_share, node, and node_loc, while the GAMS codes calls all of them node_share. This should be fixed here.

@glatterf42 glatterf42 added the docs Documentation label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

No branches or pull requests

1 participant