Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skim0119 authored Jan 25, 2022
1 parent 9bcfd0f commit 0c3d4d8
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This directory contains number of examples of elastica.
Each [example cases](#example-cases) are stored in separate subdirectories, containing case descriptions, run file, and all other data/script necessary to run.
More [advanced cases](#advanced-cases) are stored in separate repository with its description.

## Example Cases
## Case Examples

Some examples provide additional files or links to published paper for a complete description.
Examples can serve as a starting template for customized usages.
Expand Down Expand Up @@ -42,9 +42,6 @@ Examples can serve as a starting template for customized usages.
* [MuscularFlagella](./MuscularFlagella)
* __Purpose__: Example of customizing [Joint module](./MuscularFlagella/connection_flagella.py) and [Force module](./MuscularFlagella/muscle_forces_flagella.py) to implement muscular flagella.
* __Features__: MuscleForces(custom implemented)
* [Visualization](./Visualization)
* __Purpose__: Include simple examples of raytrace rendering data.
* __Features__: POVray
* [RodContactCase](./RodContactCase)
* [RodRodContact](./RodContactCase/RodRodContact)
* __Purpose__: Demonstrates contact between two rods, for different initial conditions.
Expand All @@ -57,6 +54,16 @@ Examples can serve as a starting template for customized usages.
* __Purpose__: Demonstrates rod self contact with Solenoid example.
* __Features__: CosseratRod, SelonoidsBC, SelfContact

## Functional Examples

* [RestartExample](./RestartExample)
* __Purpose__: Demonstrate the usage of restart module.
* __Features__: save_state, load_state
* [Visualization](./Visualization)
* __Purpose__: Include simple examples of raytrace rendering data.
* __Features__: POVray

## Advanced Cases

* [Elastica RL control](https://github.com/GazzolaLab/Elastica-RL-control) - Case presented in [<strong>Elastica: A compliant mechanics environment for soft robotic control</strong>](https://doi.org/10.1109/LRA.2021.3063698)
* [Gym Softrobot](https://github.com/skim0119/gym-softrobot) - Soft-robot control environment developed in OpenAI-gym format to study slender body control with reinforcement learning.

0 comments on commit 0c3d4d8

Please sign in to comment.