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

Add page with cross-package how-tos #10

Open
kennedy-mindermann opened this issue Oct 11, 2024 · 2 comments
Open

Add page with cross-package how-tos #10

kennedy-mindermann opened this issue Oct 11, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kennedy-mindermann
Copy link

Add a page that contains cross-package how-tos.

@kdayday do you have a better idea of what should be included here?

@kdayday
Copy link
Collaborator

kdayday commented Oct 14, 2024

@kennedy-mindermann We probably need to brainstorm this, as well as desired/undesired redundancy with individual package how-to's. Some thoughts:

  • A start-to-finish Sienna\Ops how-to, including building a system (PSY), running a PCM (PSI), analyzing results (PA), graphing results (PowerGraphics)
  • Similarly, a start-to-finish Sienna\Dyn tutorial (PSY, PSID, PA, PowerGraphics, others)
  • Probably also a Sienna\Data tutorial for symmetry, I'm less familiar with what that should contain outside PSY
  • A Sienna\Ops to Sienna\Dyn cross-application tutorial, using operating points from PCM results to run dynamics simulations

Concerns to resolve, probably same as with SIIPExamples: How to include these tutorials in automated testing frameworks to catch breaking changes

@kennedy-mindermann kennedy-mindermann added the documentation Improvements or additions to documentation label Nov 6, 2024
@kdayday
Copy link
Collaborator

kdayday commented Dec 24, 2024

I split this out into #25, #26, #27, #28, #29 to match the 5 use cases we're highlighting on the main website, though we'll want to add more eventually

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

No branches or pull requests

4 participants