kararrr/README.md

73 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2022-01-15 01:12:02 -07:00
# KARARRR
2022-01-15 00:27:22 -07:00
Kicad AutoRouter, ARRR `<make pirate sound>`.
An autorouter kludge for KiCad 6 and Python 3.
2022-01-15 01:24:57 -07:00
![kararrr screenshot](examples/kararrr-pcb.png)
2022-01-15 00:36:12 -07:00
# Installation
HOWTO install.
```
git clone https://spacecruft.org/spacecruft/kararrr
cd kararrr
2022-01-15 01:43:52 -07:00
# Install distro Python Pip, such as on Debian stable (Bullseye/11);
apt update
apt install python3-pip
2022-01-15 00:36:12 -07:00
# Install python deps as you like, such as:
2022-01-15 00:57:19 -07:00
pip3 install --user --upgrade -r requirements.txt
2022-01-15 00:36:12 -07:00
```
# Usage
HOWTO use.
```
# Process netlist with live view.
2022-01-15 11:31:47 -07:00
./pcb.py --v 1 examples/netlist.pcb | ./view.py
2022-01-15 00:36:12 -07:00
# Process netlist, redirect to "anim" file.
2022-01-15 11:31:47 -07:00
./pcb.py --v 1 examples/netlist.pcb > anim
2022-01-15 00:36:12 -07:00
# View "anim" file using aggDraw.
2022-01-15 11:31:47 -07:00
./view.py anim
2022-01-15 00:36:12 -07:00
# View "anim" file using matplotlib
2022-01-15 11:31:47 -07:00
./view_mpl.py anim
2022-01-15 00:36:12 -07:00
```
2022-01-15 00:27:22 -07:00
# Upstream
Based on Python-PCB for Python2 by Chris Hinsley,
released under the GPLv2 license, source code available here:
* https://github.com/vygr/Python-PCB
2022-01-15 12:07:34 -07:00
Other bits from other repos for reading `.dsn` are from here:
* https://github.com/vygr/C-PCB
* https://github.com/vygr/Go-PCB
2022-01-15 00:27:22 -07:00
# Disclaimer
Alpha software, not for use.
2022-01-15 01:20:20 -07:00
This somewhat works standalone now in Python3, but not with KiCad.
2022-01-15 00:27:22 -07:00
# Copyright
GPLv2 license.
Copyright (C) 2014, 2015, Chris Hinsley
Copyright (C) 2022, Jeff Moe