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

Typos, duplicated files, and complete tutorials #3

Open
13 tasks
bernalde opened this issue Jul 15, 2024 · 3 comments
Open
13 tasks

Typos, duplicated files, and complete tutorials #3

bernalde opened this issue Jul 15, 2024 · 3 comments
Assignees

Comments

@bernalde
Copy link
Member

bernalde commented Jul 15, 2024

This work was left incomplete.
I tried to use it for teaching and unfortunately it was not at a stage to be shared.
Please give it a complete read and correct issues with it.
@ZedongPeng coordinates with @Hamtabardool and @AlbertLee125 to start a list of requirements in this issue and we will work on it as a series of PRs.

TODO:

  • Improve the section titles, such as parts a,b,c,d, ...
  • Replacing the Bernal Research Group with the SECQUOIA group in page footer.
  • Resolve the TODOs
  • Use ChatGPT to polish the description.
  • Remove unused commented code.
  • Pyomo Summer Workshop 2018 Exercise Problem - Python (dulplicated, I prefer this one instead of separate them into different sections.)
  • Improve "Pyomo Summer Workshop 2018 Exercise Problem - Python" to "Python Basics"
  • The email address is not working in Pyomo Fundamentals
  • Ipopt failure in Pyomo Nonlinear Problems Notebook. (Refer to QUBO workshop)
  • Where is the evaluation_error_bounds_soln.py and evaluation_error_bounds2_soln.py in Pyomo Nonlinear Problems Notebook? At least we need to link the file in the notebook. Or just remove them.
  • The positioning of the equations in the Pyomo Nonlinear Problems Notebook (1.3. Alternative Formulations).
  • Maybe the index is not necessary and we can consider removing it.
  • Set up the workflow using GitHub Actions.
@bernalde
Copy link
Member Author

Use this as an example to restructure the files:
https://jckantor.github.io/ND-Pyomo-Cookbook/notebooks/09.01-notebook-style-guide.html

@bernalde
Copy link
Member Author

Also, missing models from the tutorial can be found here https://github.com/Pyomo/pyomo-tutorials

@bernalde
Copy link
Member Author

bernalde commented Sep 3, 2024

The main tutorial to be followed is here https://jupyterbook.org/en/stable/start/your-first-book.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants