Out is an open-source printed circuit board by bhdl, from the bhdl/bhdl repository on GitHub. It is a 2-layer board of 334.5 × 153.8 mm with 128 parts on 83 nets.
Its parts include 44 diodes and 36 ICs.
README
README.md
Board HDL: A Programming Language and System for making PCBs
This project is currently developed on a new IDE called CodePod, which is not publicly available yet. The src folder here is exported from CodePod IDE. We're working on making CodePod available for the general public. Issues are being tracked in this repo.
BHDL is a programming language embedded in
racket. In addition to the language, the system
consists of a layout co-design system based on functional picture, REPL-driven
interactive development and visualization, libraries, KiCAD compatible exporter,
and placement engines including an optimization-based anlytical placer (ePlace)
and simulated annealing based detailed placer.
You can now run racket and require bhdl. The first time requiring bhdl, it will download footprint library to ~/.config/bhdl/bhdl-footprints (Linux) or ~/Library/Application Support/bhdl/bhdl-footprints (MacOS).
In the future, you can update the package if there're updates upstream via:
shell
raco pkg update src
note TODO package name should be bhdl
JupyterLab IDE
In general, you can run racket programs via command line, editor plugins, IDEs. We are not covering them here. Instead, we recommand run the program via jupyter notebook. To set it up, first install jupyter:
On MacOS, it is a little trickier to setup libzmq. Specifically, you need to copy the library to the racket's library path, otherwise racket won't find it:
note:
iracket does not allow write access to file system by default. So you have to
modify the kernel file with a -t
parameter. In short, you need
to modify the content of ~/.local/share/jupyter/kernels/racket/kernel.json on
your system from ["racket","-l","iracket/iracket","--","{connection_file}"] to
["racket","-l","iracket/iracket","--","-t","{connection_file}"]
Then start the jupyterlab server:
shell
jupyter lab
You'll be able to create racket notebooks in the JupyterLab IDE. Inside the
notebook, try (require bhdl) and some of the exampels.
Placement (Optional)
To run the placement engine, you need setup
julia. Refer to their installation guide on how to
install Julia.
Install the BHDL julia package:
text
julia
]add https://github.com/bhdl/bhdl
Then run the server:
text
import BHDL
BHDL.web_server()
This will listen on http://0.0.0.0:8082. To use this, in racket, set the
parameter placer-url, and call circuit-export with #:auto-place #t:
This package will detect if Nvidia GPU is available, and use it if possible. The
first time invoking the package, julia will download and instantiate the
dependencies and download CUDA (julia will not use your system's CUDA setup).
The first time the placement is running, Julia will pre-compile the code, thus
maybe a little slower. Subsequent placement request will be much faster (which
is why we use a server instead of invoking the command for every placement request).
Freerouting (Optional)
To use routing, you need to have
freerouting available. We tested
on
freerouting-v1.4.4. Make
sure freerouting-1.4.4-executable.jar is available in your $PATH.
It measures 334.5 × 153.8 mm and has 2 copper layers, 1.6 mm thick.
What parts does the Out use?
128 parts. The full list of its parts is on this page, with links to each part's symbol and footprint where PCBKit's library has them.
Where can I download the Out KiCad files?
From the bhdl/bhdl repository on GitHub, at the commit this page was made from: the board is bhdl-test/out/bhdl-key-matrix-module/out.kicad_pcb. PCBKit opens the board in the browser, with nothing to install.
Can I use the Out design in my own project?
Its repository states no licence, so its author keeps all rights: ask bhdl before reusing the design.