Skip to content

Commit

Permalink
docs: Add gymnasium env names to README
Browse files Browse the repository at this point in the history
  • Loading branch information
iwishiwasaneagle committed Mar 28, 2023
1 parent ce9ef68 commit 42361c1
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,23 @@ Provide a [gymnasium] style interface using a physics simulation engine ([pybull

> :warning: This code is still in alpha and **will** change over time as I use it :warning:
## Environments

The environment documentation can be found [here](https://jdrones.janhendrikewers.uk/envs.html)

### Base Dynamics

1. `PyBulletDroneEnv-v0` [:link:](https://jdrones.janhendrikewers.uk/envs.html#pybulletdroneenv)
2. `NonLinearDynamicModelDroneEnv-v0` [:link:](https://jdrones.janhendrikewers.uk/envs.html#nonlineardynamicmodeldroneenv)
3. `LinearDynamicModelDroneEnv-v0` [:link:](https://jdrones.janhendrikewers.uk/envs.html#lineardynamicmodeldroneenv)

### Attitude
1. `LQRDroneEnv-v0` [:link:](https://jdrones.janhendrikewers.uk/envs.html#lqrdroneenv)

### Position
1. `FirstOrderPolyPositionDroneEnv-v0` [:link:](https://jdrones.janhendrikewers.uk/envs.html#firstorderpolypositiondroneenv)
2`FifthOrderPolyPositionDroneEnv-v0` [:link:](https://jdrones.janhendrikewers.uk/envs.html#fifthorderpolypositiondroneenv)

## Development

Create the local development environment:
Expand Down Expand Up @@ -38,10 +55,12 @@ PYTHONPATH=$GIT_DIR/src python -m pytest -s -q -n auto --only-slow-integration $

- [ ] Better sensor modelling and kalman filters
- [ ] Performance improvements of simulation using either compiled code or a JIT
- [ ] Better controllers
- [ ] Better trajectory generation between waypoints
- [x] Better controllers
- LQR
- [x] Better trajectory generation between waypoints
- First- and fifth-order polynomial trajectory generation
- [x] Examples
- [ ] Proper integration testing
- [x] Proper integration testing
- [ ] Higher fidelity motor models

[gymnasium]: https://gymnasium.farama.org/
Expand Down

0 comments on commit 42361c1

Please sign in to comment.