diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ea176867c8216f380ee8ec970c352a7483703516 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +### Generic Planar Robots + +In this package, generic robot for simple tests are made available for gym environments. + +## Dependencies + +This package depends on casadi for dynamics generation and gym. +Dependencies should be installed through pip installation, see below. + +## Installation +```bash +pip3 install -e . +``` + +## Switching + +Environments can be created using the normal gym syntax. +For example the below code line creates a planar robot with 3 links and a constant k. +Actions are torques to the individual joints. +```python +env = gym.make('nLink-reacher-tor-v0', n=3, dt=0.01, k=2.1) +``` diff --git a/setup.py b/setup.py index b832caffafa030893fe45413f3a51bbec273dc09..1b62c29df4702515ab50cce9293a267117b0f4fd 100644 --- a/setup.py +++ b/setup.py @@ -4,5 +4,6 @@ setup( name="planarEnvs", version='0.0.1', install_requires=['gym', - 'numpy'] + 'numpy', + 'casadi'] )