Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TaegonChung authored Oct 1, 2023
1 parent 9be2698 commit f776534
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,23 @@ Newtonian Mechanics Model for C. elegans Locomotion

## Tested Environment
- Windows 10
- Python 3.8.18
- NumPy 1.19.0
- Numba 0.54.0
- SciPy 1.5.0
- Matplotlib 3.4.2
- Python 3.8.18
- NumPy 1.19.0
- Numba 0.54.0
- SciPy 1.5.0
- Matplotlib 3.4.2

## Usage
1. Install library by `pip install elegansbot` or 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 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.
- 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 wish to use ElegansBot with a pre-determined $\theta_{\mathrm{ctrl}}$ (kymogram), it's recommended to utilize the "run" method of an instance of the "Worm" class.

## Examples
You may check out examples in the "examples/" directory.
Try running `python examples/example01.py` for dynamic input
or `python examples/example02.py` for kymogram input
or `python examples/example02.py` for kymogram input.

## Local Demo
Execute the following command:
Expand All @@ -45,7 +45,7 @@ python elegansbot.py
- `Video_S1_omega_turn.avi` : Video from the supplementary section of our paper.
- `Video_S2_delta_turn.avi` : Another video from the supplementary section of our paper.

## Citation
## Citing ElegansBot
- 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
Expand Down

0 comments on commit f776534

Please sign in to comment.