STEPSS Documentation

The official documentation website for Static and Transient Electric Power Systems Simulation.

This repository holds the documentation website, part of the STEPSS power system simulation platform. It is built with Astro 7 and Starlight 0.41 and deployed to GitHub Pages.

🔗 Live site: https://stepss.sps-lab.org/

Local Development

# Install dependencies
npm install

# Start dev server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Project Structure

src/content/docs/
├── index.mdx                    # Landing page
├── getting-started/             # Overview, installation, quick start, license
├── user-guide/                  # Network, power flow, disturbances, solver, file formats, eigenanalysis
├── models/                      # Synchronous machine, exciters, governors, injectors, two-ports
├── python/                       # Python API overview, install, API, Helios, examples
├── developer/                   # CODEGEN, CG Studio, user models, URAMSES
├── test-systems/                # Nordic and 5-bus test systems
└── resources/                   # References, repositories

Editing Documentation

All documentation lives in src/content/docs/ as Markdown (.md) or MDX (.mdx) files. Each file has frontmatter with title and description.

Adding a New Page

1. Create a .md file in the appropriate directory
2. Add frontmatter:

   ---
   title: Your Page Title
   description: Brief description
   ---

3. Add the page to the sidebar in astro.config.mjs
4. Commit and push; GitHub Actions will deploy automatically

Math Support

KaTeX is enabled for LaTeX math rendering. Use $...$ for inline math and $$...$$ for display math.

Tabbed Content

Use Starlight's built-in components for tabbed content (GUI/Python/CLI):

import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs>
<TabItem label="Python">
Content for Python tab
</TabItem>
<TabItem label="GUI">
Content for GUI tab
</TabItem>
</Tabs>

Deployment

The site deploys automatically via GitHub Actions when pushing to main. The workflow:

1. Checks out the code
2. Installs Node.js 22 and dependencies
3. Builds the static site with astro build
4. Deploys to GitHub Pages

Pull requests get a build check via a separate workflow (.github/workflows/pr-check.yml).

Manual Deployment

Trigger a manual deployment from the GitHub Actions tab → "Deploy to GitHub Pages" → "Run workflow".

Related Repositories

Repository	Description
stepss-java-ui	Java GUI
stepss-python-ui	Python API (RAMSES + Helios power flow)
stepss-userguide	LaTeX source docs
stepss-uramses	User-defined models
stepss-eigenanalysis	Eigenvalue analysis

License

• Documentation content (src/content/docs/, public/images/) is licensed under CC BY 4.0. Share and adapt freely, including commercially, with appropriate credit.
• Website code (Astro config, components, styles) is licensed under MIT.
• public/stepss_docs.pdf: the compiled user guide, redistributed from stepss-userguide under that repository's licence.

The STEPSS software documented here is not covered by either licence; several components are proprietary or non-commercial. See NOTICE and the licence page.

Authors

Developed and maintained by the Sustainable Power Systems Laboratory (SPS-L) at the Cyprus University of Technology, under the direction of Dr. Petros Aristidou.

Documentation authors:

• Dr. Petros Aristidou: Cyprus University of Technology
• Dr. Thierry Van Cutsem: University of Liège