Power Systems Wiki

This wiki is an open reference designed to compile and share terminologies used in the power systems engineering.

Why This Wiki Exists

Language is inherently ambiguous, and power system terminologies are no exception. Inspired by an email titled “Definitions of Smart Grids a Decade Ago – What Has Changed?” on Power-Globe in 2024, I decided to compile terminologies from papers, standards, reports, and other traceable sources to build this wiki.

Contributing

We welcome contributions from the community! If you have suggestions, corrections, or new terms to add, please open an issue or submit a pull request.

Website Overview

Built with MkDocs Material, the site is driven by a JSON term database and generated at deploy time. Key features include:

• Metadata Display: Last update date, tags, and related term links
• Navigation: Previous/Next term links for easy browsing
• Direct Editing: A link to edit the term directly on GitHub
• Community Engagement: Integrated Giscus comments

REST API

The PS-Wiki REST API provides read-only access to term data in JSON format. It is deployed via Cloudflare Workers and documented using the OpenAPI 3.1.0 specification at https://pswiki-api.jinninggm.workers.dev/openapi.json

Developer Notes

• All timestamps use ISO 8601 format (YYYY-MM-DD or full date-time).
• Pagination uses opaque cursors; pass next_cursor to retrieve the next page.
• The /v1/terms and /v1/terms/{id} endpoints are suitable for integration with external AI clients.

Development

All developer workflows go through the pswiki.py CLI at the repo root:

python pswiki.py new <term-id>        # scaffold a new term
python pswiki.py process <term-id>    # run the full pipeline for one term
python pswiki.py process              # process all terms
python pswiki.py validate             # validate all term JSON files
python pswiki.py serve                # local preview at http://localhost:8000
python pswiki.py build                # production build

Install Python dependencies before first use:

pip install -r requirements-dev.txt -r requirements-docs.txt

Terms are authored in _wiki/<term-id>.md and stored as JSON in database/json/. Never hand-edit the JSON files directly — run python pswiki.py process to regenerate them.

License

This project is licensed under the CC-BY-NC 4.0.