aimdl-dashboard-api
FastAPI backend for the AIMD-L visualization dashboard, the real-time laboratory dashboard for the Autonomous Instrumented Materials Discovery Laboratory (AIMD-L) at Johns Hopkins University.
The backend authenticates to the HTMDEC Girder data portal, walks instrument folder hierarchies (MAXIMA, HELIX, SPHINX), and proxies visualization PNGs to the frontend so the browser never needs Girder credentials.
Installation
pip install aimdl-dashboard-api
Usage
Set your Girder API key (obtain from https://data.htmdec.org → Account → API Keys),
then launch the server:
export AIMDL_API_KEY="your-key-here"
aimdl-dashboard --port 8000
Options:
aimdl-dashboard --host 0.0.0.0 --port 8000 [--reload]
The API will be available at http://localhost:8000/api and the OpenAPI docs
at http://localhost:8000/docs.
Environment variables
| Variable | Required | Description |
|---|---|---|
AIMDL_API_KEY |
Yes | Girder API key for data.htmdec.org |
GIRDER_API_URL |
No | Override Girder API URL (default: htmdec.org) |
PER_INSTRUMENT_LIMIT |
No | Items fetched per data type from Girder on cache refresh (default: 100) |
DEFAULT_PER_INSTRUMENT |
No | Items returned per instrument in API responses (default: 30) |
Documentation
See the main repository README for full architecture, frontend setup, kiosk deployment, and development notes.
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for aimdl-dashboard-api 0.1.9
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 |
|---|---|---|---|---|
| aimdl_dashboard_api-0.1.9.tar.gz | 10.4 kB | With provenance | Details for aimdl_dashboard_api-0.1.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aimdl_dashboard_api-0.1.9-py3-none-any.whl | Python 3 | none | any | Details for aimdl_dashboard_api-0.1.9-py3-none-any.whl |
Total release size: 19.9 kB
Release files / aimdl_dashboard_api-0.1.9.tar.gz
| Download URL | aimdl_dashboard_api-0.1.9.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c2665cb149bac794d2ebb8f93ce0a980921436f4674b760601d834478d8d770
|
|
BLAKE2b-256 checksum How to use checksums |
00f2e9604a7530c419c0e6af4dbacfdba71a05ef1a5c9219580136c1d22f56eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 16, 2026.
Transparency logRelease files / aimdl_dashboard_api-0.1.9-py3-none-any.whl
| Download URL | aimdl_dashboard_api-0.1.9-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
77baa4d5b06cd2d774e66c367fef5650d840a9682bacc1a4c6a5a599307de41c
|
|
BLAKE2b-256 checksum How to use checksums |
4d14ed3614c01969eb44abeaa515e60bf13badb2d65581eb67d94a0a1d0337e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 16, 2026.
Transparency logSecurity for aimdl-dashboard-api 0.1.9
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for aimdl_dashboard_api-0.1.9.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 16, 2026.
Transparency logA 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.
