# pyrung

> Pythonic PLC simulation engine — write ladder logic in Python, simulate with full debug support.

## Home

- [Home](https://pyrung.com/pyrung/)

## Learn

- [Know Python? Learn Ladder Logic.](https://pyrung.com/pyrung/learn/)
- [The Scan Cycle](https://pyrung.com/pyrung/learn/scan-cycle/)
- [Tags](https://pyrung.com/pyrung/learn/tags/)
- [Latch and Reset](https://pyrung.com/pyrung/learn/latch-reset/)
- [Assignment](https://pyrung.com/pyrung/learn/assignment/)
- [Timers](https://pyrung.com/pyrung/learn/timers/)
- [Counters](https://pyrung.com/pyrung/learn/counters/)
- [State Machines](https://pyrung.com/pyrung/learn/state-machines/)
- [Branches and OR Logic](https://pyrung.com/pyrung/learn/branches/)
- [Structured Tags and Blocks](https://pyrung.com/pyrung/learn/structured-tags/)
- [Testing](https://pyrung.com/pyrung/learn/testing/)
- [From Simulation to Hardware](https://pyrung.com/pyrung/learn/hardware/)

## Getting Started

- [Installation](https://pyrung.com/pyrung/getting-started/installation/)
- [Quickstart](https://pyrung.com/pyrung/getting-started/quickstart/)
- [Core Concepts](https://pyrung.com/pyrung/getting-started/concepts/)

## Instruction Reference

- [Instruction Reference](https://pyrung.com/pyrung/instructions/)
- [Rungs](https://pyrung.com/pyrung/instructions/rungs/)
- [Conditions](https://pyrung.com/pyrung/instructions/conditions/)
- [Coils](https://pyrung.com/pyrung/instructions/coils/)
- [Timers & Counters](https://pyrung.com/pyrung/instructions/timers-counters/)
- [Data Movement](https://pyrung.com/pyrung/instructions/copy/)
- [Math](https://pyrung.com/pyrung/instructions/math/)
- [Drum, Shift & Search](https://pyrung.com/pyrung/instructions/drum-shift-search/)
- [Program Control](https://pyrung.com/pyrung/instructions/program-control/)
- [Communication](https://pyrung.com/pyrung/instructions/communication/)

## Guides — Essentials

- [Execution Engine](https://pyrung.com/pyrung/guides/runner/)
- [Testing](https://pyrung.com/pyrung/guides/testing/)
- [Tag Structures](https://pyrung.com/pyrung/guides/tag-structures/)

## Guides — Declare, Analyze, Commission

- [Overview](https://pyrung.com/pyrung/guides/commissioning/)
- [Physical Annotations](https://pyrung.com/pyrung/guides/physical-harness/)
- [Analysis](https://pyrung.com/pyrung/guides/analysis/)
- [Program Structure](https://pyrung.com/pyrung/guides/analysis-structure/)
- [Ladder Lints](https://pyrung.com/pyrung/guides/ladder-lints/)
- [Diagnosis](https://pyrung.com/pyrung/guides/analysis-diagnosis/)
- [Cause & Effect](https://pyrung.com/pyrung/guides/analysis-causal/)
- [Test Coverage](https://pyrung.com/pyrung/guides/analysis-coverage/)
- [Verification](https://pyrung.com/pyrung/guides/verification/)

## Guides — Platform

- [CLICK Quickstart](https://pyrung.com/pyrung/guides/click-quickstart/)
- [CLICK Cheatsheet](https://pyrung.com/pyrung/guides/click-cheatsheet/)
- [CircuitPython Quickstart](https://pyrung.com/pyrung/guides/circuitpy-quickstart/)

## Guides — Tools

- [VS Code Debugger](https://pyrung.com/pyrung/guides/dap-vscode/)
- [Architecture](https://pyrung.com/pyrung/guides/architecture/)

## Dialects

- [CLICK PLC](https://pyrung.com/pyrung/dialects/click/)
- [CLICK Python Codegen](https://pyrung.com/pyrung/dialects/click-codegen/)
- [CircuitPython](https://pyrung.com/pyrung/dialects/circuitpy/)
- [CircuitPython Modbus TCP](https://pyrung.com/pyrung/dialects/circuitpy-modbus/)

## API Reference

- [Overview](https://pyrung.com/pyrung/reference/)
- [Runtime API](https://pyrung.com/pyrung/reference/api/runtime/)
- [Data Model API](https://pyrung.com/pyrung/reference/api/data-model/)
- [Program Structure API](https://pyrung.com/pyrung/reference/api/program-structure/)
- [Instruction Set API](https://pyrung.com/pyrung/reference/api/instruction-set/)
- [Click Dialect API](https://pyrung.com/pyrung/reference/api/click-dialect/)
- [CircuitPython Dialect API](https://pyrung.com/pyrung/reference/api/circuitpy-dialect/)