Metadata-Version: 2.1
Name: jsrm
Version: 0.0.2
Summary: Kinematic and dynamic models of continuum and articulated soft robots.
Author-email: Maximilian Stölzle <maximilian@stoelzle.ch>
Maintainer-email: Maximilian Stölzle <maximilian@stoelzle.ch>
License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
        of the Software, and to permit persons to whom the Software is furnished to do
        so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/tud-cor-sr/jax-soft-robot-modelling
Project-URL: Bug Reports, https://github.com/tud-cor-sr/jax-soft-robot-modelling/issues
Project-URL: Source, https://github.com/tud-cor-sr/jax-soft-robot-modelling
Keywords: JAX,Soft Robotics,Kinematics,Dynamics
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: examples
Provides-Extra: test
License-File: LICENSE.txt

# JAX Soft Robot Modelling

## Installation

The plugin can be installed from PyPI:

```bash
pip install jax-soft-robot-modelling
```

or locally from the source code:

```bash
pip install .
```

If you want to run the examples, you will also need to install the following dependencies:

```bash
pip install ".[examples]"
```

## Usage
Always, first source all necessary environment variables when opening a new terminal:

```bash
source 01-configure-env-vars.sh
```

Then, we can symbolically derive the pendulum kinematics and dynamics

```bash
    python examples/derive_pendulum.py
```

Finally, we can simulate the pendulum
```bash
    python examples/simulate_pendulum.py
```
