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

New Docs Outline #2

Open
claytonpbarrows opened this issue Apr 23, 2024 · 1 comment
Open

New Docs Outline #2

claytonpbarrows opened this issue Apr 23, 2024 · 1 comment
Assignees

Comments

@claytonpbarrows
Copy link
Member

Sienna

Explanation

How it works?

Design principals

Sienna capabilities

  • Sienna\Data
  • Sienna\Ops
  • Sienna\Dyn

Tutorials

How-to-guide

Reference

__

Capability Specific Docs

Sienna\Data

Explanation

Tutorials

  • power flow
  • dataset assembly

How-to-guide

Reference

Sienna\Ops

Explanation

Tutorials

  • Grid integration study
    • load packages
    • assemble data
    • define problem
    • define simulation
    • analyze result
  • Market simulation

How-to-guide

  • UC/ED
  • DC vs. ACOPF

Reference

Sienna\Dyn

Explanation

Tutorials

  • power flow
  • dataset assembly

How-to-guide

Reference

@kdayday
Copy link
Collaborator

kdayday commented Dec 10, 2024

Expanded outline, from before we got the Jekyll template and started the 2-part website structure:

Sienna

Explanation

Why Use Sienna?

- Narrative of possible users and use cases, highlighting a couple actual studies if possible
     Maybe get comms help with this?

How it works?

- Three core, interconnected applications
    - triangle diagram
- Other items Jose has prepped

Design principals

- Why Julia?
- Modularity
     - maybe a new diagram showing heirarchy of applications and .jl packages?
- Design choices for high renewables
- Other items Jose has prepped
- Open-source?

Sienna capabilities

- Sienna\Data
- Sienna\Ops
- Sienna\Dyn
- Cross-cutting (Sienna-wide?) capabilities

How-to-guide

- Install Sienna
- Navigate the Sienna docs

Sienna-wide tutorials

- Grid integration study
    - load packages
    - assemble data with Sienna\data
    - define problem and simulation with Sienna\Ops
    - analyze result
- Integrated operational simulation and stability analysis (better name?)
    - load packages
    - Load data
    - Run simulation with Sienna\ops
    - Select steady state points
    - Feed steady state points into stability analysis with Sienna\dyn
    - Analyze results

Reference

- Glossary and acronyms?
- Contact (Slack, email)
- More resources (youtube)
- Team
- Publications
- How to cite Sienna
- Contributing
- License

Capability Specific Docs

Sienna\Data

Explanation

- Why use Sienna\Data? (narrative of possible use cases, highlighting a couple actual studies if possible and linking to tutorials)
- .jl packages and how they relate

Tutorials

- Assembling a dataset
- powerflow

How-to-guide

- Import or export to PSSE?

Reference

- Links to individual package API's

Sienna\Ops

Explanation

- Why use Sienna\Ops? (narrative of possible use cases, highlighting a couple actual studies if possible and linking to tutorials)
- .jl packages and how they relate

Tutorials

 - Market simulation

How-to-guide

- UC/ED
- DC vs. ACOPF

Reference

- Links to individual package API's

Sienna\Dyn

Explanation

- Why use Sienna\Dyn? (narrative of possible use cases, highlighting a couple actual studies if possible and linking to tutorials)
- .jl packages and how they relate
- Difference between general PSY approach to structs (data does not define model) and \dyn approach (data defines model)?

Tutorials

- ?

How-to-guide

- ?

Reference

- Links to individual package API's
- Glossary and sienna\dyn-specific acronyms

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 a pull request may close this issue.

2 participants