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

Lifecycle doc #182

Merged
Merged

Conversation

darrylmelander
Copy link
Collaborator

This is documentation for RUCs, SCEDs, plugins, and the overall simulation lifecycle. There is definitely overlap with existing documentation, particularly Modeling Concepts -> The Prescient Simulation Cycle. That documentation is supposed to be conceptual, while the new documentation is meant to be functional (i.e., help someone actually use Prescient correctly). I'm not at all against changes to reduce overlap, improve how things are organized, and so on. But for now, we've got a real-world user that needs more than he could glean from the existing page, so I'd rather commit less-than-perfect information and make changes later.

This PR includes removing Windows-style line breaks, so if you just look at the "files changed" tab you'll get overwhelmed. You'll want to focus on the 4 new files in the Reference section.

The after_get_initial_* functions make more sense if you don't
call it a forecast model or actuals model, so I changed the following
callback names:

 * after_get_initial_actuals_model_for_sced
 * after_get_initial_forecast_model_for_sced
 * after_get_initial_actuals_model_for_simulation_actuals
@darrylmelander darrylmelander merged commit 31ac9f5 into grid-parity-exchange:main Dec 21, 2023
6 checks passed
@darrylmelander darrylmelander deleted the lifecycle-doc branch December 21, 2023 20:30
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

Successfully merging this pull request may close these issues.

1 participant