packpay project documentation
v0.72.103.244
Introduction
This is the documentation home for the packpay project.
Concept and planning
- Concept
- project concept, goals, and origin (extracted from dudhya), the taxonomy of breadboards, the best practices for breadboards and schematics, and the glossary of terms.
- Workflow
- from a real netlist to a placed diagram, and back – "the loop", concretely, with real verified commands.
- Troubleshooting
- when a real circuit doesn't lay out cleanly – placement failure, crowding, or a valid but non-optimal result.
- Future Research
- open questions and deferred work.
Standards and process
- Development Standard
- coding, documentation, build, and packaging rules, including the KiCad environment setup procedure.
- Developer Debugging
- a real, working methodology for investigating this project's own code, with worked examples from its own real history.
Reference
- KicadGen
- practical reference for kicad_gen.py's own small language for scripting KiCad schematics.
- Library Reference
- practical reference for this project's own shared libraries (netlist.py, auto_layout.py, kicad_layout.py, footprint.py, breadboard_lib.py).
Record of work
- Research Journal
- dated witness of work done, newest first.
Manual pages
- ppnetlist(1)
- load and print a KiCad netlist export.
- pprender(1)
- render a breadboard wiring diagram from a real KiCad schematic.
- ppfootprint(1)
- print a real KiCad footprint's own pad and courtyard geometry.
- pptest_netlist(1)
- check netlist.py's own real kicad-cli-backed loading pipeline.
- ppauto_layout(1)
- print a real schematic's own breadboard placement, as plain text.
- ppvisualize(1)
- a minimal, fast, structural-only breadboard placement preview.
- ppexample_circuit1(1)
- build this project's own first synthetic test circuit.
- ppexample_circuit2(1)
- build this project's own second synthetic test circuit.
- pprender_footprints(1)
- render a fixed panel of real footprint comparisons.
- ppbreadboard_config(1)
- parse and print a real breadboard configuration file.
- breadboard_config(5)
- the breadboard configuration file format itself, single-board and multi-board.
- pptest_breadboard_config(1)
- check breadboard_config.py's own real parser/writer.
- ppbuild_instructions(1)
- convert a breadboard layout into a step-by-step build guide.
- pptest_build_instructions(1)
- check build_instructions.py's own real pipeline.
- pptest_regression(1)
- broad, multi-circuit placement and render regression sweep.