wei
The Workflow Execution Interface (WEI) for Autonomous Discovery/Self Driving Laboratories (AD/SDLs)
For more details and specific examples of how to use wei, please see our documentation.
Table of Contents
Usage
To get started with WEI, we recommend:
- Consulting the Documentation
- Using the WEI Template Workcell as a starting point to learn how to use WEI, and how to create your own Workcell.
Installation
To install the ad_sdl.wei python package, you can run pip install ad_sdl.wei
To install from source, run
git clone https://github.com/ad-sdl/wei.git
cd wei
pip install -e .
Development
- Install Docker for your platform of choice
- For managing the Python Package, install PDM
- For automatic development checks/linting/formatting, install pre-commit
- Ensure you have
GNU makeinstalled (on apt-based systems like Debian and Ubuntu,sudo apt install make) - Clone the repository.
- Within the cloned repository, run
make buildto build the python package and docker image locally.
For a complete list of make commands available, run make help.
Using PDM
Using Pre-commit
- To run pre-commit checks before committing, run
pre-commit run --all-filesormake checks - NONE OF THE FOLLOWING SHOULD BE DONE REGULARLY, AND ALL CHECKS SHOULD BE PASSING BEFORE BRANCHES ARE MERGED
- To skip linting during commits, use
SKIP=ruff git commit ... - To skip formatting during commits, use
SKIP=ruff-format git commit ... - To skip all pre-commit hooks, use
git commit --no-verify ...
- To skip linting during commits, use
- See pre-commit documentation for more
Building Documentation
- You can install the documentation python dependencies with
pip install -e '.[docs]'orpdm install -G docs - You must install Graphviz
- You can build the docs with
make docs
Contributing
Please report bugs, enhancement requests, or questions through the Issue Tracker.
If you are looking to contribute, please see CONTRIBUTING.md.
Citing
@Article{D3DD00142C,
author ="Vescovi, Rafael and Ginsburg, Tobias and Hippe, Kyle and Ozgulbas, Doga and Stone, Casey and Stroka, Abraham and Butler, Rory and Blaiszik, Ben and Brettin, Tom and Chard, Kyle and Hereld, Mark and Ramanathan, Arvind and Stevens, Rick and Vriza, Aikaterini and Xu, Jie and Zhang, Qingteng and Foster, Ian",
title ="Towards a modular architecture for science factories",
journal ="Digital Discovery",
year ="2023",
pages ="-",
publisher ="RSC",
doi ="10.1039/D3DD00142C",
url ="http://dx.doi.org/10.1039/D3DD00142C",
abstract ="Advances in robotic automation{,} high-performance computing (HPC){,} and artificial intelligence (AI) encourage us to conceive of science factories: large{,} general-purpose computation- and AI-enabled self-driving laboratories (SDLs) with the generality and scale needed both to tackle large discovery problems and to support thousands of scientists. Science factories require modular hardware and software that can be replicated for scale and (re)configured to support many applications. To this end{,} we propose a prototype modular science factory architecture in which reconfigurable modules encapsulating scientific instruments are linked with manipulators to form workcells{,} that can themselves be combined to form larger assemblages{,} and linked with distributed computing for simulation{,} AI model training and inference{,} and related tasks. Workflows that perform sets of actions on modules can be specified{,} and various applications{,} comprising workflows plus associated computational and data manipulation steps{,} can be run concurrently. We report on our experiences prototyping this architecture and applying it in experiments involving 15 different robotic apparatus{,} five applications (one in education{,} two in biology{,} two in materials){,} and a variety of workflows{,} across four laboratories. We describe the reuse of modules{,} workcells{,} and workflows in different applications{,} the migration of applications between workcells{,} and the use of digital twins{,} and suggest directions for future work aimed at yet more generality and scalability. Code and data are available at https://ad-sdl.github.io/wei2023 and in the ESI."}
License
WEI is MIT licensed, as seen in the LICENSE file.
Metadata
Release files for ad_sdl.wei 0.7.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ad_sdl_wei-0.7.4.tar.gz | 60.9 kB | Without provenance | Details for ad_sdl_wei-0.7.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ad_sdl_wei-0.7.4-py3-none-any.whl | Python 3 | none | any | Details for ad_sdl_wei-0.7.4-py3-none-any.whl |
Total release size: 136.4 kB
Release files / ad_sdl_wei-0.7.4.tar.gz
| Download URL | ad_sdl_wei-0.7.4.tar.gz |
|---|---|
| Size | 60.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37d2cc9db4e5a65accf2f3740d1e5e89534094c88a6190cf785ca4b86df99179
|
|
BLAKE2b-256 checksum How to use checksums |
45f62736c0c89093982b73f8960d72fe8b37391e785a97aaddd14204f34772a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
pdm/2.24.1 CPython/3.12.10 Linux/6.11.0-1012-azure
|
Release files / ad_sdl_wei-0.7.4-py3-none-any.whl
| Download URL | ad_sdl_wei-0.7.4-py3-none-any.whl |
|---|---|
| Size | 75.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bdb3630dd11fdc2059c475f740be1c516b7ca69ad3e3471e185a8e62790a9b42
|
|
BLAKE2b-256 checksum How to use checksums |
956b998e9bda849d34e42014d03fac5fcda70a6aa61b3228a764e3dee9c95e6e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
pdm/2.24.1 CPython/3.12.10 Linux/6.11.0-1012-azure
|
Security for ad_sdl.wei 0.7.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.