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

Update tutorials & create new ones #735

Open
12 of 20 tasks
Tracked by #969
clizbe opened this issue Aug 18, 2023 · 3 comments
Open
12 of 20 tasks
Tracked by #969

Update tutorials & create new ones #735

clizbe opened this issue Aug 18, 2023 · 3 comments
Labels
good first issue Good for newcomers Type: epic A larger goal that encompasses multiple issues Type: new feature Add something that doesn't exist yet Zone: documentation Explanation of code, tutorials

Comments

@clizbe
Copy link
Member

clizbe commented Aug 18, 2023

Go through each of the tutorials and see if they still work and are followable.

Otherwise, adapt the other tutorials to examples or how-to sections:

Also, create new tutorials:

As well as how to's:

  • pressure driven gas system
  • storage

And update the documentation accordingly:

  • text in the overview of the documentation
  • json files for the tutorials
@clizbe
Copy link
Member Author

clizbe commented Aug 18, 2023

Related: #436, #459

@tarskul
Copy link
Collaborator

tarskul commented Aug 28, 2023

I've updated the simple system tutorial with the experience from my own struggle, mostly explaining some things in more detail (e.g. the three-way relationship for defining an efficiency) and adding some warnings for pitfalls (e.g. messing up the order in the three-way relationship). Besides the pitfalls, the tutorial seems fine.

@tarskul
Copy link
Collaborator

tarskul commented Sep 12, 2023

After some deliberation, only the first tutorial is a real tutorial. The other two should be adapted to examples or how to sections.

Then we should also add some new tutorials that cover more features of SpineOpt.

I'll edit the issue description and we should later have a discussion on these new tutorials.

@tarskul tarskul linked a pull request Sep 26, 2023 that will close this issue
4 tasks
@tarskul tarskul mentioned this issue Sep 26, 2023
4 tasks
@clizbe clizbe changed the title Check if tutorials are working Update tutorials & create new ones Oct 24, 2023
@tarskul tarskul removed a link to a pull request Dec 8, 2023
4 tasks
@clizbe clizbe added Zone: documentation Explanation of code, tutorials and removed case studies labels Jan 4, 2024
@clizbe clizbe added Type: epic A larger goal that encompasses multiple issues and removed Zone: documentation Explanation of code, tutorials labels Jan 12, 2024
@clizbe clizbe added Zone: documentation Explanation of code, tutorials Type: new feature Add something that doesn't exist yet labels Jan 26, 2024
@tarskul tarskul mentioned this issue Feb 5, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers Type: epic A larger goal that encompasses multiple issues Type: new feature Add something that doesn't exist yet Zone: documentation Explanation of code, tutorials
Projects
None yet
Development

No branches or pull requests

2 participants