Software and instructions for setting up and running an autonomous (self-driving) laboratory optics demo using dimmable RGB LEDs, a 10-channel spectrometer, a microcontroller, and an adaptive design algorithm.
Project description
self-driving-lab-demo (WIP)
Software and instructions for setting up and running an autonomous (self-driving) laboratory optics demo using dimmable RGB LEDs, a 10-channel spectrophotometer, a microcontroller, and an adaptive design algorithm.
Self-driving labs are the future; however, the capital and expertise required can be daunting. We introduce the idea of a constrained, high-dimensional, multi-objective optimization task for less than $100, a square foot of desk space, and an hour of total setup time from the shopping cart to the first "autonomous drive." We use optics rather than chemistry for our demo; after all, light is easier to move than matter. While not strictly materials-based, importantly, several core principles of a self-driving materials discovery lab are retained in this cross-domain example: sending commands to hardware to adjust physical parameters, receiving measured objective properties, decision-making via active learning, and utilizing cloud-based simulations. The demo is accessible, extensible, modular, and repeatable, making it an ideal candidate for both low-cost experimental adaptive design prototyping and learning the principles of self-driving laboratories in a low-risk setting.
See Also
-
Adafruit Forum: Developing a closed-loop feedback system via DotStar LEDs
-
Adafruit bill of materials (my original one that I ordered and am planning to prototype with)
Most of the build instructions will go into the Hackaday project page, probably with periodic updates to GitHub. GitHub will host the software that I develop.
The BOM uses Raspberry Pi (RPi) in favor of Arduino to support running complex adaptive design algorithms locally using the higher-end RPi models such as 4B with 8 GB RAM. RPi is a standalone computer, whereas Arduino is a microcontroller.
Additionally, due to the chip shortage, the current setup (2022-08-16) is designed for RPi Pico W (see https://github.com/sparks-baird/self-driving-lab-demo/issues/8), but can be adapted to other models.
ToDo:
- order parts for initial prototype
- assemble hardware
- set up RPi
- simple Blinkt! test
- simple 10-channel sensor test
- simple Blinkt! + 10-channel sensor test
- fixture to mount sensor perpendicular to LED Blinkt!
- write unit tests for Blinkt! and 10-channel sensor
- write script/library to integrate components
- "first drive" using random search
Installation
In order to set up the necessary environment:
- review and uncomment what you need in
environment.yml
and create an environmentself-driving-lab-demo
with the help of conda:conda env create -f environment.yml
- activate the new environment with:
conda activate self-driving-lab-demo
NOTE: The conda environment will have self-driving-lab-demo installed in editable mode. Some changes, e.g. in
setup.cfg
, might require you to runpip install -e .
again.
Optional and needed only once after git clone
:
-
install several pre-commit git hooks with:
pre-commit install # You might also want to run `pre-commit autoupdate`
and checkout the configuration under
.pre-commit-config.yaml
. The-n, --no-verify
flag ofgit commit
can be used to deactivate pre-commit hooks temporarily. -
install nbstripout git hooks to remove the output cells of committed notebooks with:
nbstripout --install --attributes notebooks/.gitattributes
This is useful to avoid large diffs due to plots in your notebooks. A simple
nbstripout --uninstall
will revert these changes.
Then take a look into the scripts
and notebooks
folders.
Dependency Management & Reproducibility
- Always keep your abstract (unpinned) dependencies updated in
environment.yml
and eventually insetup.cfg
if you want to ship and install your package viapip
later on. - Create concrete dependencies as
environment.lock.yml
for the exact reproduction of your environment with:conda env export -n self-driving-lab-demo -f environment.lock.yml
For multi-OS development, consider using--no-builds
during the export. - Update your current environment with respect to a new
environment.lock.yml
using:conda env update -f environment.lock.yml --prune
Project Organization
├── AUTHORS.md <- List of developers and maintainers.
├── CHANGELOG.md <- Changelog to keep track of new features and fixes.
├── CONTRIBUTING.md <- Guidelines for contributing to this project.
├── Dockerfile <- Build a docker container with `docker build .`.
├── LICENSE.txt <- License as chosen on the command-line.
├── README.md <- The top-level README for developers.
├── configs <- Directory for configurations of model & application.
├── data
│ ├── external <- Data from third party sources.
│ ├── interim <- Intermediate data that has been transformed.
│ ├── processed <- The final, canonical data sets for modeling.
│ └── raw <- The original, immutable data dump.
├── docs <- Directory for Sphinx documentation in rst or md.
├── environment.yml <- The conda environment file for reproducibility.
├── models <- Trained and serialized models, model predictions,
│ or model summaries.
├── notebooks <- Jupyter notebooks. Naming convention is a number (for
│ ordering), the creator's initials and a description,
│ e.g. `1.0-fw-initial-data-exploration`.
├── pyproject.toml <- Build configuration. Don't change! Use `pip install -e .`
│ to install for development or to build `tox -e build`.
├── references <- Data dictionaries, manuals, and all other materials.
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
│ └── figures <- Generated plots and figures for reports.
├── scripts <- Analysis and production scripts which import the
│ actual PYTHON_PKG, e.g. train_model.
├── setup.cfg <- Declarative configuration of your project.
├── setup.py <- [DEPRECATED] Use `python setup.py develop` to install for
│ development or `python setup.py bdist_wheel` to build.
├── src
│ └── self_driving_lab_demo <- Actual Python package where the main functionality goes.
├── tests <- Unit tests which can be run with `pytest`.
├── .coveragerc <- Configuration for coverage reports of unit tests.
├── .isort.cfg <- Configuration for git hook that sorts imports.
└── .pre-commit-config.yaml <- Configuration of pre-commit git hooks.
Note
This project has been set up using PyScaffold 4.2.3.post1.dev10+g7a0f254 and the dsproject extension 0.7.2.post1.dev3+g948a662.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for self-driving-lab-demo-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 592baf4ed836310a78247a8d1f087936f43bf4b617bc5a845303d1a91abc5c58 |
|
MD5 | 831a5226904d8fc492f43f175a63abc2 |
|
BLAKE2b-256 | 87adfb6ba668c882b048845267c2ef6ffe2cdaf1e103c412bb1cbd1598acd20f |
Hashes for self_driving_lab_demo-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9054e51484c0763960b513d951a596f51af5bdb9c4366c3cdbac02f36e3f357 |
|
MD5 | 5b9e640ec15acf11b5cf88384bbc4142 |
|
BLAKE2b-256 | 04a29e3e56a13a472c46112dfcf85346b188aa635b2cab38d05bc0bd8aca6629 |