The safe-autonomy-dynamics package provides an API for dynamic systems supported by a library of common functions used to access and update system dynamics.
Project description
safe-autonomy-dynamics
Intro
The safe-autonomy-dynamics package provides an API for dynamic systems supported by a library of common functions used to access and update system dynamics. These dynamics are used to build simulated environments which behave like real-world systems for the purpose of safe autonomy research and development (though their use is not limited to the safety domain). The package also includes a zoo of air and space domain dynamics modules tailored for simulating aerospace systems. The team intends to grow the zoo as new dynamic systems are studied or simulation requirements change.
Docs
Library documentation and api reference located here.
Installation
The following instructions detail how to install the safe-autonomy-dynamics library on your local system. It is recommended to install the python modules within a virtualenv or conda environment.
Installing safe-autonomy-dynamics
Clone a copy of the safe-autonomy-dynamics repo onto your local machine via SSH (recommended):
git clone git@github.com:act3-ace/safe-autonomy-dynamics.git
or HTTPS:
git clone https://github.com/act3-ace/safe-autonomy-dynamics.git
Install the safe-autonomy-dynamics module into your
environment using pip
:
cd safe-autonomy-dynamics
pip install .
For a local development version, please install
using the -e, --editable
option:
pip install -e .
Build Docs Locally
First make sure the mkdocs requirements are installed
pip install -r mkdocs-requirements.txt
Now, build the documentation and serve it locally. By default, you should be able to reach the docs on your local web browser at 127.0.0.1:8000
rm -r site
mkdocs build
cp -r docs/. site/
mkdocs serve
Public Release
Distribution A. Approved for public release; distribution is unlimited. Case Number: AFRL-2022-3202
Team
Umberto Ravaioli, Kyle Dunlap, Jamie Cunningham, John McCarroll, Kerianne Hobbs
Project details
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 safe_autonomy_dynamics-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75ae9e13950783d855e334b787b3968616774c414065572f25f92395e1a476ea |
|
MD5 | fad1893e868ce0c71c438817acc3b639 |
|
BLAKE2b-256 | 3f16e86c1c4c8d19ba2f465c7e72745f3d62608f528a7c85123a94ccae9ea69b |
Hashes for safe_autonomy_dynamics-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fc875a8ab6817a0e3ef1f3bbdfdd25233bf3f5d9a95cb7df0dd4fda5da5e9ba |
|
MD5 | da5c2ae34afa17b09664372469d49f05 |
|
BLAKE2b-256 | 40fbffd0e99704911c8ce83e1b25d7b13c1c03141705424de9f1d634c65b678d |