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

Fill in documentation gaps #951

Open
10 tasks
josephmckinsey opened this issue Mar 27, 2023 · 0 comments
Open
10 tasks

Fill in documentation gaps #951

josephmckinsey opened this issue Mar 27, 2023 · 0 comments

Comments

@josephmckinsey
Copy link

Fill in unfinished sections

  • modeler_guide/running_a_simulation/
  • modeler_guide/tips_and_tricks
  • modeler_guide/debugging_infeasible_models/
  • modeler_guide/modeling_faq/
  • model_developer_guide/adding_new_device_formulation/
  • model_developer_guide/adding_new_problem_model/
  • model_developer_guide/troubleshooting/
  • code_base_developer_guide/troubleshooting/

The tutorials seem to help with running a simulation, but the subsections of feedforward and sequences would be helpful.

Sections on adding new device formulations and problem models would be most helpful since examples of that code are often quite complex (see ReliablePowerSimulations.jl). This is also some of the most complex code usually split across many files.

Design Decisions

  • Design docs. I'm not sure if this is @jd-lara 's dissertation, but the design decisions are a bit unclear.

There's still TODOs

  • Formulation library has a lot of TODOs
@jd-lara jd-lara added this to To do in v1.0 May 8, 2023
@jd-lara jd-lara moved this from To do to In progress in v1.0 May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
v1.0
  
In progress
Development

No branches or pull requests

3 participants