A REST API for the Project Bluebird Digital Twin
Project description
The REST API for BluebirdATC
It is possible to run the BluebirdATC digital twin in a server process, such that the simulation will evolve at regular time intervals, and Agents and/or frontend visualization software can interact with it via HTTP requests. In particular, users can:
- Query available scenario categories and scenarios.
- Load a selected scenario.
- Evolve the simulation by a specified time interval.
- Obtain the current state of the
Environment. - Submit
Actionsto individual aircraft. - Save logfiles with data on all steps of the simulation.
In order to run the app, with all the correct dependencies for this feature, from the BluebirdATC/bluebird-api directory, run the command:
uv run uvicorn bluebird_api:app --port 8000
You should then be able to go to http://localhost:8000 in a web browser, and see the message "Hello, BluebirdATC!".
To see the full list and description of API endpoints, with the application running, go to http://localhost:8000/docs.
Frontend visualisation
The app also serves the frontend visualization (more details on that can be found here), at the URL http://localhost:8000/hmi.
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 bluebird_api-0.1.3.tar.gz.
File metadata
- Download URL: bluebird_api-0.1.3.tar.gz
- Upload date:
- Size: 13.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02585997756e9df1abba00b7db1d5bbd31573ab02c1dd39f6c965db4ea077fc1
|
|
| MD5 |
6112bb5f66c9685675c7af0cdd7a9637
|
|
| BLAKE2b-256 |
b87f4779aa4598ae8eee3c301bd70ac7345146ee1d69fee9d621298df9051283
|
File details
Details for the file bluebird_api-0.1.3-py3-none-any.whl.
File metadata
- Download URL: bluebird_api-0.1.3-py3-none-any.whl
- Upload date:
- Size: 1.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bc5fd4c9083decdbe8a2c25436e928bd596509c437aa152fc17c943b8661fb81
|
|
| MD5 |
f7600b11a353ac35a862826b293c2018
|
|
| BLAKE2b-256 |
e8257972775f992b0a3bd7a595b1b95626f6175e0d6e83b95c717d1ca8c49107
|
