From 718ba0b7f60d19b8cd1bfdde60d18776dd910d58 Mon Sep 17 00:00:00 2001 From: Tejaswin Parthasarathy Date: Sat, 1 Jan 2022 13:25:44 -0600 Subject: [PATCH] docs : updated readme with repository, paper link --- README.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6f03472..9ab0376 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,35 @@ # Snake Kinematics Sandbox -A sandbox to play around with a kinematic model of snake-locomotion, with and +An interactive online sandbox to play around with a kinematic model of snake-locomotion, with and without active frictional modulation. -The online sandbox can be seen [here](https://gazzolalab.github.io/kinematic_snake_sandbox/). -The numerical code powering the simulator can be found here : TODO +> :rocket: The online sandbox can be seen [here](https://gazzolalab.github.io/kinematic_snake_sandbox/). + +The numerical code (written in `Python`) powering the simulator [can be found here](https://github.com/tp5uiuc/kinematic_snake). + +## What is it? +An online, interactive simulator that provides intuition for the behavior of a snake as it adapts its gait in terrains of various nature. + +If you are using code taken from this repository please cite the following paper :) + +Friction modulation in limbless, three-dimensional gaits and heterogeneous terrains, doi : [10.1038/s41467-021-26276-x](https://doi.org/10.1038/s41467-021-26276-x) + +``` +@Article{Zhang2021, +author={Zhang, Xiaotian +and Naughton, Noel +and Parthasarathy, Tejaswin +and Gazzola, Mattia}, +title={Friction modulation in limbless, three-dimensional gaits and heterogeneous terrains}, +journal={Nature Communications}, +year={2021}, +month={Oct}, +day={19}, +volume={12}, +number={1}, +pages={6076}, +issn={2041-1723}, +doi={10.1038/s41467-021-26276-x}, +url={https://doi.org/10.1038/s41467-021-26276-x} +} +```