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

Translate the code to the formulation #292

Open
abelsiqueira opened this issue Nov 22, 2023 · 7 comments
Open

Translate the code to the formulation #292

abelsiqueira opened this issue Nov 22, 2023 · 7 comments
Labels
Type: improvement Better way of doing something Zone: documentation Improvements or additions to documentation

Comments

@abelsiqueira
Copy link
Member

abelsiqueira commented Nov 22, 2023

Document the implementation of the formulation, referencing the terms in the equations to the corresponding Jump expressions, and explaining how they work. This is important for researchers who want to extend the formulation to model aspects of an energy system not covered by the latest version of Tulipa. -- @suvayu

@abelsiqueira abelsiqueira added Zone: documentation Improvements or additions to documentation Type: improvement Better way of doing something labels Nov 23, 2023
@clizbe
Copy link
Member

clizbe commented Nov 23, 2023

@abelsiqueira
Will this also include how to reference things in the structure? Or maybe we can add that in the comments when certain things are defined? Maybe it's just practice, but as a beginner I'm having trouble figuring out how to access variables/data in the new structure.

@abelsiqueira
Copy link
Member Author

We have to add some more documentation to that as well, but it's a separated issue.

@clizbe
Copy link
Member

clizbe commented Dec 13, 2023

This is important but will be easier to do once the model is more complete and stable.

@clizbe clizbe changed the title Dev docs for model <-> mathematical formulation Translate the code to the formulation Jan 5, 2024
@datejada
Copy link
Member

This documentation is for developers who are working on the formulation

@clizbe
Copy link
Member

clizbe commented Jan 18, 2024

@datejada Do you think it's useful to give it a higher priority then?

@datejada
Copy link
Member

@clizbe Eventually is fine for now; depending on how many people start joining the Team to develop more formulation/constraints, then we can increase the priority

@clizbe
Copy link
Member

clizbe commented Sep 19, 2024

I think this is waiting on the refactor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: improvement Better way of doing something Zone: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants