Skip to content

lgili/PulsimGUI

Repository files navigation

PulsimGui — Dark Theme

PulsimGui

Professional GUI for power electronics simulation with Pulsim.

Release PyPI Docs License: MIT Python 3.10+

Download latest release · Install from PyPI · Documentation · Report a bug


PulsimGui is a cross-platform desktop interface for Pulsim, focused on modeling and validating power converter topologies.

Key Features

  • Schematic editor with drag-and-drop workflow.
  • Component library focused on power electronics.
  • Transient simulation with advanced solver controls.
  • Integrated waveform viewer with signal measurements.
  • Ready-to-run examples (RC, buck, boost, and more).

Official Documentation

Full documentation is available at:

Main content includes:

  • Installation and execution
  • GUI guides and workflow
  • Simulation and backend configuration
  • Practical tutorials
  • Technical reference for contributors

Installation

1. Release (Recommended)

Use installers from Releases.

2. Install via pip

python3 -m pip install --upgrade pip
python3 -m pip install pulsimgui

Run:

pulsimgui

The pulsimgui package is published to PyPI by the release pipeline (.github/workflows/release.yml) whenever a new tag v* is released.

3. Development setup (source code)

git clone https://github.com/lgili/PulsimGUI.git
cd PulsimGui
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -e ".[dev]"
python3 -m pulsimgui

Recommended Backend

For reproducible behavior, use pulsim v0.6.1.

Quick check:

python3 -c "import pulsim; print(pulsim.__version__)"

In the app: Preferences → Simulation → Backend Runtime.

Development

Tests

pytest

Lint

ruff check src tests

Local docs build

python3 -m pip install -r docs/requirements.txt
mkdocs build --strict
mkdocs serve

GitHub Pages (Docs)

Documentation is published through:

  • .github/workflows/docs-pages.yml

Automatic deploy runs on main and workflow_dispatch.

Repository setting required: Settings → Pages → Source: GitHub Actions.

Contributing

  • Open issues for bug reports and feature requests.
  • For PRs, include context, validation steps, and evidence (logs/screenshots).
  • Update docs whenever a user workflow or feature changes.

License

MIT — see LICENSE.

About

PulsimGui is an open-source desktop GUI for power electronics simulation with Pulsim, featuring schematic capture, transient/DC/AC analysis, waveform inspection, and ready-to-run converter templates (buck, boost, flyback, and closed-loop buck).

Resources

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages