FastAPI backend for the AIMD-L visualization dashboard
Project description
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) |
Documentation
See the main repository README for full architecture, frontend setup, kiosk deployment, and development notes.
License
MIT
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aimdl_dashboard_api-0.1.1.tar.gz.
File metadata
- Download URL: aimdl_dashboard_api-0.1.1.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4dd62782fb7fec41d6f42c6d012c194ffa4f6aa84ac04909c0fbe02264e859a
|
|
| MD5 |
1c0fa3b29dbb44cbf451717917f395ce
|
|
| BLAKE2b-256 |
d0abf775faf34f7acb54fa097f14a89d89bfc2919813050a8e44d0c53043af0e
|
Provenance
The following attestation bundles were made for aimdl_dashboard_api-0.1.1.tar.gz:
Publisher:
release.yml on openmsi/aimdl_dashboard
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aimdl_dashboard_api-0.1.1.tar.gz -
Subject digest:
a4dd62782fb7fec41d6f42c6d012c194ffa4f6aa84ac04909c0fbe02264e859a - Sigstore transparency entry: 1296746789
- Sigstore integration time:
-
Permalink:
openmsi/aimdl_dashboard@fc909d2d699805ba6bf95952359354723f9f6065 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/openmsi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fc909d2d699805ba6bf95952359354723f9f6065 -
Trigger Event:
push
-
Statement type:
File details
Details for the file aimdl_dashboard_api-0.1.1-py3-none-any.whl.
File metadata
- Download URL: aimdl_dashboard_api-0.1.1-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e7f36bb760b2f884139c40fe0d11e68a75c50a6b54def46f4e36f031219c8769
|
|
| MD5 |
216ee6c335317ee2b166b5ea5dc73215
|
|
| BLAKE2b-256 |
283fd8b038294203b5d5e9a9d479672ab349ffbc19e3d508de0377c6543ed143
|
Provenance
The following attestation bundles were made for aimdl_dashboard_api-0.1.1-py3-none-any.whl:
Publisher:
release.yml on openmsi/aimdl_dashboard
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aimdl_dashboard_api-0.1.1-py3-none-any.whl -
Subject digest:
e7f36bb760b2f884139c40fe0d11e68a75c50a6b54def46f4e36f031219c8769 - Sigstore transparency entry: 1296746913
- Sigstore integration time:
-
Permalink:
openmsi/aimdl_dashboard@fc909d2d699805ba6bf95952359354723f9f6065 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/openmsi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fc909d2d699805ba6bf95952359354723f9f6065 -
Trigger Event:
push
-
Statement type:
