From 07ba0f2424376636d7f2f1123083a942d7bdb840 Mon Sep 17 00:00:00 2001 From: TaegonChung Date: Thu, 28 Sep 2023 17:37:42 +0900 Subject: [PATCH] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d966282..33cab76 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # ElegansBot -Newtonian Mechanics Model for C. elegans Locomotion +Newtonian Mechanics Model for C. elegans Locomotion +Demo: https://taegonchung.github.io/elegansbot/ ## Requirements - Python (version 3) @@ -20,7 +21,7 @@ Newtonian Mechanics Model for C. elegans Locomotion 1. Download the `elegansbot.py` file into your project directory. 2. Use `from elegansbot import Worm` to import the library. 3. Refer to the detailed instructions in the docstring of the "Worm" class. Below is a brief overview of potential use-cases: - - If you wish to use ElegansBot with a pre-determined $\theta_{\mathrm{ctrl}}$ (target body angle), it's recommended to utilize the "run" method of an instance of the "Worm" class. + - If you wish to use ElegansBot with a pre-determined $\theta_{\mathrm{ctrl}}$ (target body angle or kymogram), it's recommended to utilize the "run" method of an instance of the "Worm" class. - If you want to determine $\theta_{\mathrm{ctrl}}$ dynamically, it's advised to update "act" (equivalent to theta_ctrl) manually and then invoke the "steps" method on an instance of the "Worm" class. ## Web Demo @@ -44,4 +45,4 @@ python elegansbot.py - If ElegansBot has been significant in your research, and you would like to acknowledge this work in your academic publication, please consider citing the following paper (this citation may be updated in the future): ``` Chung, T., Chang, I., & Kim, S. (2023). ElegansBot: Development of equation of motion deciphering locomotion including omega turns of Caenorhabditis elegans (p. 2023.09.26.559644). bioRxiv. https://doi.org/10.1101/2023.09.26.559644 -``` \ No newline at end of file +```