stepss-cg-studio 5.3.0__tar.gz

stepss_cg_studio-5.3.0/LICENSE

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include Communication that is conspicuously
+      marked or otherwise designated in writing by the copyright owner
+      as "Not a Work").
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution".
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Petros Aristidou
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

stepss_cg_studio-5.3.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: stepss-cg-studio
+Version: 5.3.0
+Summary: Visual block diagram editor for STEPSS CODEGEN power system models
+Author-email: Petros Aristidou <apetros@pm.me>
+License: Apache-2.0 AND LicenseRef-STEPSS-Academic-Public-License
+Project-URL: Homepage, https://stepss.sps-lab.org/
+Project-URL: Documentation, https://stepss.sps-lab.org/developer/cg-studio/
+Project-URL: Repository, https://github.com/SPS-L/stepss-cg-studio
+Project-URL: Issues, https://github.com/SPS-L/stepss-cg-studio/issues
+Keywords: CODEGEN,Power Systems,STEPSS,RAMSES,Block Diagram
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.110.0
+Requires-Dist: uvicorn>=0.29.0
+Requires-Dist: aiofiles>=23.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: httpx>=0.27.0; extra == "dev"
+Requires-Dist: playwright>=1.40; extra == "dev"
+Requires-Dist: pytest-playwright>=0.4.0; extra == "dev"
+Dynamic: license-file
+
+[![PyPI version](https://img.shields.io/pypi/v/stepss-cg-studio)](https://pypi.org/project/stepss-cg-studio/)
+[![CI](https://img.shields.io/github/actions/workflow/status/SPS-L/stepss-cg-studio/ci.yml?branch=main&label=tests)](https://github.com/SPS-L/stepss-cg-studio/actions)
+[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache%202.0%20%2B%20bundled%20CODEGEN-green.svg)](#license)
+[![Docs](https://img.shields.io/github/actions/workflow/status/SPS-L/stepss-docs/deploy.yml?branch=main&label=docs)](https://stepss.sps-lab.org/developer/cg-studio/)
+
+# CODEGEN Studio
+
+CODEGEN Studio is a browser-based, drag-and-drop visual editor for building [STEPSS CODEGEN](https://stepss.sps-lab.org/developer/user-models/) User-Defined Models, part of the [STEPSS](https://stepss.sps-lab.org/) power system simulation platform. It lets you create device models by wiring blocks on a canvas instead of manually writing DSL files.
+
+STEPSS has been developed by [Dr. Petros Aristidou](https://sps-lab.org/) (Cyprus University of Technology) and Dr. Thierry Van Cutsem (Emeritus, University of Liège).
+
+## Overview
+
+CODEGEN Studio replaces the manual editing of CODEGEN DSL `.txt` files with a graphical workflow. You drag blocks from a categorised palette, connect input/output ports to define signal flow, fill in metadata tables, and export ready-to-compile DSL files, or run the bundled CODEGEN directly from the editor to generate Fortran `.f90` source.
+
+The tool supports all four CODEGEN model types:
+
+| Type | Purpose | Mandatory Outputs |
+|------|---------|-------------------|
+| **EXC** | Excitation controller | `vf` |
+| **TOR** | Torque controller | `tm` |
+| **INJ** | Current injector | `ix`, `iy` |
+| **TWOP** | Two-port device | `ix1`, `iy1`, `ix2`, `iy2` |
+
+## Features
+
+- **Drag-and-drop block diagram editor**: assemble models visually on a canvas with 54 built-in blocks
+- **Live DSL preview**: syntax-highlighted code updates in real time as you edit
+- **Lossless round-trip**: import existing `.txt` DSL files with automatic canvas layout, edit, and re-export
+- **One-click Fortran generation**: the CODEGEN executables ship in the wheel, so this works on a fresh install
+- **Project save/load**: JSON project files preserve full editor state including block positions
+- **Mandatory output validation**: warns when required outputs for the model type are missing
+- **Undo/redo**: 60-step history with keyboard shortcuts
+- **Extensible block catalogue**: add new blocks via a single JSON entry, no code changes required
+- **No build step**: vanilla JavaScript frontend served by a Python backend
+
+## Installation
+
+### Requirements
+
+- Python ≥ 3.10
+- A modern browser (Chrome, Firefox, or Edge)
+
+### Install from PyPI
+
+```bash
+pip install stepss-cg-studio
+```
+
+The CODEGEN executables are bundled in the wheel, for Linux x86-64, Windows x86-64 and macOS Apple Silicon. **Run Codegen works on a fresh install**: there is nothing to obtain, install or configure, and no setting to point anywhere.
+
+macOS is the one platform that needs anything else:
+
+```bash
+brew install gcc
+```
+
+Apple does not support fully static executables, so that CODEGEN build links against `libgfortran`. The Linux and Windows builds are statically linked and need nothing at all.
+
+The bundled CODEGEN is named in Settings (gear icon), and in the two leading components of this package's own version: `stepss-cg-studio` 5.3.0 and 5.3.1 both run CODEGEN 5.3. See [Versioning](#versioning).
+
+### Install from source (for development)
+
+```bash
+git clone https://github.com/SPS-L/stepss-cg-studio.git
+cd stepss-cg-studio
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```bash
+cg-studio
+```
+
+This starts the local server and opens your browser to the editor at `http://localhost:8765`. That's it.
+
+You can also run it as a Python module:
+
+```bash
+python -m cg_studio
+```
+
+### CLI options
+
+```bash
+cg-studio --port 9000        # use a different port
+cg-studio --host 0.0.0.0     # allow network access
+cg-studio --no-browser        # start server without opening browser
+```
+
+### Building a model
+
+1. **Select model type and name**: choose EXC, TOR, INJ, or TWOP from the toolbar dropdown
+2. **Add blocks**: drag blocks from the left-hand palette onto the canvas
+3. **Connect blocks**: wire output ports to input ports to define signal flow
+4. **Edit block properties**: select a block to configure output names and arguments in the inspector
+5. **Populate metadata**: fill in Data, Parameters, States, and Observables in the tabs below the canvas
+6. **Export**: click "Export DSL" for the `.txt` file, or "Run Codegen" to generate Fortran directly
+
+### Keyboard shortcuts
+
+| Shortcut | Action |
+|----------|--------|
+| Ctrl/Cmd + S | Save project |
+| Ctrl/Cmd + Z | Undo |
+| Ctrl/Cmd + Shift + Z (or Ctrl/Cmd + Y) | Redo |
+| Delete / Backspace | Delete selected block |
+| Escape | Close modal |
+
+## Project Structure
+
+```
+stepss-cg-studio/
+├── pyproject.toml              # Package config, dependencies, entry point
+├── src/cg_studio/
+│   ├── __init__.py             # Package version (<bundled CODEGEN X.Y>.<counter>)
+│   ├── _bundled.py             # Which CODEGEN release bin/ holds
+│   ├── __main__.py             # python -m cg_studio support
+│   ├── cli.py                  # CLI entry point (cg-studio command)
+│   ├── config.py               # Platform-aware config & codegen resolution
+│   ├── app.py                  # FastAPI server & API endpoints
+│   ├── dsl_parser.py           # DSL .txt → ModelProject dict
+│   ├── dsl_emitter.py          # ModelProject dict → DSL .txt
+│   ├── bin/                    # Bundled CODEGEN: lin/, win/, mac/ + LICENSE-CODEGEN
+│   └── frontend/               # Static web assets (no build step)
+│       ├── index.html
+│       ├── css/style.css
+│       ├── js/                 # Vanilla JS modules
+│       └── blocks.json         # Block catalogue (54 blocks, extend here)
+├── tests/                      # Pytest test suite (~150 tests)
+├── tools/                      # Release automation: update_codegen.sh, bump_version.sh
+├── examples/                   # Example DSL models (.txt) and projects (.json)
+├── docs/                       # Design documents
+├── run.bat                     # Windows dev launcher
+└── run.sh                      # Linux/macOS dev launcher
+```
+
+## Adding New Blocks
+
+Edit `src/cg_studio/frontend/blocks.json`: add a single JSON entry with the block name, ports, argument schema, DSL line templates, and category. No JavaScript or Python changes required.
+
+## Running Tests
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run all tests
+pytest tests/ -v
+
+# Run specific test file
+pytest tests/test_parser.py -v
+
+# Run a single test
+pytest tests/test_parser.py::test_function_name -v
+```
+
+CI runs pytest on Python 3.10–3.12 via GitHub Actions.
+
+## Settings
+
+Access via the gear icon in the toolbar:
+
+- **Bundled CODEGEN**: which CODEGEN release this install runs. Read-only, and not a setting: the package version is derived from it, so running a different CODEGEN means installing a different `stepss-cg-studio`.
+- **Server host**: change to `0.0.0.0` for network access (default: `127.0.0.1`)
+- **Server port**: HTTP port (default: `8765`)
+
+Settings are stored in a platform-specific config directory:
+- **Windows:** `%LOCALAPPDATA%\cg-studio\config.json`
+- **Linux/macOS:** `~/.config/cg-studio/config.json`
+
+Also editable via the REST API at `http://localhost:8765/docs`.
+
+## Documentation
+
+Full documentation is available at [https://stepss.sps-lab.org/developer/cg-studio/](https://stepss.sps-lab.org/developer/cg-studio/).
+
+- [User-Defined Models](https://stepss.sps-lab.org/developer/user-models/): DSL format specification
+- [CODEGEN Blocks Library](https://stepss.sps-lab.org/developer/codegen-library/): complete block reference
+- [CODEGEN Model Examples](https://stepss.sps-lab.org/developer/codegen-examples/): annotated example files
+
+## Versioning
+
+The version is `<bundled CODEGEN X.Y>.<counter>`, so the leading pair always names the generator in the wheel:
+
+| Event | Version |
+|---|---|
+| CODEGEN v5.3 published | `5.3.0` |
+| a change on the Python side | `5.3.1` |
+| another change on the Python side | `5.3.2` |
+| CODEGEN v5.4 published | `5.4.0` |
+
+Publishing a CODEGEN release is what starts a sequence: `stepss-Codegen` tells this repository, `.github/workflows/sync-codegen-release.yml` refreshes the executables, proves the rebuilt wheel generates Fortran on all three platforms, and only then releases and publishes to PyPI. Nothing here is bumped by hand.
+
+## License
+
+This package is **mixed-licence**, and the badge above says so on purpose.
+
+- The Python and JavaScript in this repository are **Apache License 2.0**. See [LICENSE](LICENSE). Copyright © Petros Aristidou.
+- The **CODEGEN executables bundled in the wheel are not**. CODEGEN is the property of **Dr. Thierry Van Cutsem** and is distributed as a compiled executable under an **Academic Public License**: free of charge for non-commercial use (teaching, and research at universities and non-profit institutions); commercial use requires a separate licence from the authors. Its source is in none of the public STEPSS repositories. The licence text ships beside the executables as `cg_studio/bin/LICENSE-CODEGEN`.
+
+[STEPSS licensing](https://stepss.sps-lab.org/getting-started/license/) is the single owner of these facts; everything above is a summary of that page.
+
+## Authors
+
+Developed and maintained by the [Sustainable Power Systems Laboratory (SPS-L)](https://sps-lab.org/) at the Cyprus University of Technology, under the direction of Dr. Petros Aristidou.
+
+- [Dr. Petros Aristidou](https://sps-lab.org/): Cyprus University of Technology
+- Dr. Thierry Van Cutsem: Emeritus, University of Liège
+
+## Support
+
+- Documentation: [https://stepss.sps-lab.org/developer/cg-studio/](https://stepss.sps-lab.org/developer/cg-studio/)
+- Issues: [https://github.com/SPS-L/stepss-cg-studio/issues](https://github.com/SPS-L/stepss-cg-studio/issues)
+- Project page: [https://sps-lab.org/](https://sps-lab.org/)

stepss_cg_studio-5.3.0/README.md

@@ -0,0 +1,217 @@
+[![PyPI version](https://img.shields.io/pypi/v/stepss-cg-studio)](https://pypi.org/project/stepss-cg-studio/)
+[![CI](https://img.shields.io/github/actions/workflow/status/SPS-L/stepss-cg-studio/ci.yml?branch=main&label=tests)](https://github.com/SPS-L/stepss-cg-studio/actions)
+[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache%202.0%20%2B%20bundled%20CODEGEN-green.svg)](#license)
+[![Docs](https://img.shields.io/github/actions/workflow/status/SPS-L/stepss-docs/deploy.yml?branch=main&label=docs)](https://stepss.sps-lab.org/developer/cg-studio/)
+
+# CODEGEN Studio
+
+CODEGEN Studio is a browser-based, drag-and-drop visual editor for building [STEPSS CODEGEN](https://stepss.sps-lab.org/developer/user-models/) User-Defined Models, part of the [STEPSS](https://stepss.sps-lab.org/) power system simulation platform. It lets you create device models by wiring blocks on a canvas instead of manually writing DSL files.
+
+STEPSS has been developed by [Dr. Petros Aristidou](https://sps-lab.org/) (Cyprus University of Technology) and Dr. Thierry Van Cutsem (Emeritus, University of Liège).
+
+## Overview
+
+CODEGEN Studio replaces the manual editing of CODEGEN DSL `.txt` files with a graphical workflow. You drag blocks from a categorised palette, connect input/output ports to define signal flow, fill in metadata tables, and export ready-to-compile DSL files, or run the bundled CODEGEN directly from the editor to generate Fortran `.f90` source.
+
+The tool supports all four CODEGEN model types:
+
+| Type | Purpose | Mandatory Outputs |
+|------|---------|-------------------|
+| **EXC** | Excitation controller | `vf` |
+| **TOR** | Torque controller | `tm` |
+| **INJ** | Current injector | `ix`, `iy` |
+| **TWOP** | Two-port device | `ix1`, `iy1`, `ix2`, `iy2` |
+
+## Features
+
+- **Drag-and-drop block diagram editor**: assemble models visually on a canvas with 54 built-in blocks
+- **Live DSL preview**: syntax-highlighted code updates in real time as you edit
+- **Lossless round-trip**: import existing `.txt` DSL files with automatic canvas layout, edit, and re-export
+- **One-click Fortran generation**: the CODEGEN executables ship in the wheel, so this works on a fresh install
+- **Project save/load**: JSON project files preserve full editor state including block positions
+- **Mandatory output validation**: warns when required outputs for the model type are missing
+- **Undo/redo**: 60-step history with keyboard shortcuts
+- **Extensible block catalogue**: add new blocks via a single JSON entry, no code changes required
+- **No build step**: vanilla JavaScript frontend served by a Python backend
+
+## Installation
+
+### Requirements
+
+- Python ≥ 3.10
+- A modern browser (Chrome, Firefox, or Edge)
+
+### Install from PyPI
+
+```bash
+pip install stepss-cg-studio
+```
+
+The CODEGEN executables are bundled in the wheel, for Linux x86-64, Windows x86-64 and macOS Apple Silicon. **Run Codegen works on a fresh install**: there is nothing to obtain, install or configure, and no setting to point anywhere.
+
+macOS is the one platform that needs anything else:
+
+```bash
+brew install gcc
+```
+
+Apple does not support fully static executables, so that CODEGEN build links against `libgfortran`. The Linux and Windows builds are statically linked and need nothing at all.
+
+The bundled CODEGEN is named in Settings (gear icon), and in the two leading components of this package's own version: `stepss-cg-studio` 5.3.0 and 5.3.1 both run CODEGEN 5.3. See [Versioning](#versioning).
+
+### Install from source (for development)
+
+```bash
+git clone https://github.com/SPS-L/stepss-cg-studio.git
+cd stepss-cg-studio
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```bash
+cg-studio
+```
+
+This starts the local server and opens your browser to the editor at `http://localhost:8765`. That's it.
+
+You can also run it as a Python module:
+
+```bash
+python -m cg_studio
+```
+
+### CLI options
+
+```bash
+cg-studio --port 9000        # use a different port
+cg-studio --host 0.0.0.0     # allow network access
+cg-studio --no-browser        # start server without opening browser
+```
+
+### Building a model
+
+1. **Select model type and name**: choose EXC, TOR, INJ, or TWOP from the toolbar dropdown
+2. **Add blocks**: drag blocks from the left-hand palette onto the canvas
+3. **Connect blocks**: wire output ports to input ports to define signal flow
+4. **Edit block properties**: select a block to configure output names and arguments in the inspector
+5. **Populate metadata**: fill in Data, Parameters, States, and Observables in the tabs below the canvas
+6. **Export**: click "Export DSL" for the `.txt` file, or "Run Codegen" to generate Fortran directly
+
+### Keyboard shortcuts
+
+| Shortcut | Action |
+|----------|--------|
+| Ctrl/Cmd + S | Save project |
+| Ctrl/Cmd + Z | Undo |
+| Ctrl/Cmd + Shift + Z (or Ctrl/Cmd + Y) | Redo |
+| Delete / Backspace | Delete selected block |
+| Escape | Close modal |
+
+## Project Structure
+
+```
+stepss-cg-studio/
+├── pyproject.toml              # Package config, dependencies, entry point
+├── src/cg_studio/
+│   ├── __init__.py             # Package version (<bundled CODEGEN X.Y>.<counter>)
+│   ├── _bundled.py             # Which CODEGEN release bin/ holds
+│   ├── __main__.py             # python -m cg_studio support
+│   ├── cli.py                  # CLI entry point (cg-studio command)
+│   ├── config.py               # Platform-aware config & codegen resolution
+│   ├── app.py                  # FastAPI server & API endpoints
+│   ├── dsl_parser.py           # DSL .txt → ModelProject dict
+│   ├── dsl_emitter.py          # ModelProject dict → DSL .txt
+│   ├── bin/                    # Bundled CODEGEN: lin/, win/, mac/ + LICENSE-CODEGEN
+│   └── frontend/               # Static web assets (no build step)
+│       ├── index.html
+│       ├── css/style.css
+│       ├── js/                 # Vanilla JS modules
+│       └── blocks.json         # Block catalogue (54 blocks, extend here)
+├── tests/                      # Pytest test suite (~150 tests)
+├── tools/                      # Release automation: update_codegen.sh, bump_version.sh
+├── examples/                   # Example DSL models (.txt) and projects (.json)
+├── docs/                       # Design documents
+├── run.bat                     # Windows dev launcher
+└── run.sh                      # Linux/macOS dev launcher
+```
+
+## Adding New Blocks
+
+Edit `src/cg_studio/frontend/blocks.json`: add a single JSON entry with the block name, ports, argument schema, DSL line templates, and category. No JavaScript or Python changes required.
+
+## Running Tests
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run all tests
+pytest tests/ -v
+
+# Run specific test file
+pytest tests/test_parser.py -v
+
+# Run a single test
+pytest tests/test_parser.py::test_function_name -v
+```
+
+CI runs pytest on Python 3.10–3.12 via GitHub Actions.
+
+## Settings
+
+Access via the gear icon in the toolbar:
+
+- **Bundled CODEGEN**: which CODEGEN release this install runs. Read-only, and not a setting: the package version is derived from it, so running a different CODEGEN means installing a different `stepss-cg-studio`.
+- **Server host**: change to `0.0.0.0` for network access (default: `127.0.0.1`)
+- **Server port**: HTTP port (default: `8765`)
+
+Settings are stored in a platform-specific config directory:
+- **Windows:** `%LOCALAPPDATA%\cg-studio\config.json`
+- **Linux/macOS:** `~/.config/cg-studio/config.json`
+
+Also editable via the REST API at `http://localhost:8765/docs`.
+
+## Documentation
+
+Full documentation is available at [https://stepss.sps-lab.org/developer/cg-studio/](https://stepss.sps-lab.org/developer/cg-studio/).
+
+- [User-Defined Models](https://stepss.sps-lab.org/developer/user-models/): DSL format specification
+- [CODEGEN Blocks Library](https://stepss.sps-lab.org/developer/codegen-library/): complete block reference
+- [CODEGEN Model Examples](https://stepss.sps-lab.org/developer/codegen-examples/): annotated example files
+
+## Versioning
+
+The version is `<bundled CODEGEN X.Y>.<counter>`, so the leading pair always names the generator in the wheel:
+
+| Event | Version |
+|---|---|
+| CODEGEN v5.3 published | `5.3.0` |
+| a change on the Python side | `5.3.1` |
+| another change on the Python side | `5.3.2` |
+| CODEGEN v5.4 published | `5.4.0` |
+
+Publishing a CODEGEN release is what starts a sequence: `stepss-Codegen` tells this repository, `.github/workflows/sync-codegen-release.yml` refreshes the executables, proves the rebuilt wheel generates Fortran on all three platforms, and only then releases and publishes to PyPI. Nothing here is bumped by hand.
+
+## License
+
+This package is **mixed-licence**, and the badge above says so on purpose.
+
+- The Python and JavaScript in this repository are **Apache License 2.0**. See [LICENSE](LICENSE). Copyright © Petros Aristidou.
+- The **CODEGEN executables bundled in the wheel are not**. CODEGEN is the property of **Dr. Thierry Van Cutsem** and is distributed as a compiled executable under an **Academic Public License**: free of charge for non-commercial use (teaching, and research at universities and non-profit institutions); commercial use requires a separate licence from the authors. Its source is in none of the public STEPSS repositories. The licence text ships beside the executables as `cg_studio/bin/LICENSE-CODEGEN`.
+
+[STEPSS licensing](https://stepss.sps-lab.org/getting-started/license/) is the single owner of these facts; everything above is a summary of that page.
+
+## Authors
+
+Developed and maintained by the [Sustainable Power Systems Laboratory (SPS-L)](https://sps-lab.org/) at the Cyprus University of Technology, under the direction of Dr. Petros Aristidou.
+
+- [Dr. Petros Aristidou](https://sps-lab.org/): Cyprus University of Technology
+- Dr. Thierry Van Cutsem: Emeritus, University of Liège
+
+## Support
+
+- Documentation: [https://stepss.sps-lab.org/developer/cg-studio/](https://stepss.sps-lab.org/developer/cg-studio/)
+- Issues: [https://github.com/SPS-L/stepss-cg-studio/issues](https://github.com/SPS-L/stepss-cg-studio/issues)
+- Project page: [https://sps-lab.org/](https://sps-lab.org/)