From 7cb55fb194fb0a05bd795562ff39bfbabc6da044 Mon Sep 17 00:00:00 2001
From: Arman Tekinalp <53585636+armantekinalp@users.noreply.github.com>
Date: Wed, 27 Jul 2022 23:51:50 -0500
Subject: [PATCH 1/3] Update README.md
---
README.md | 86 ++++++++++++++++++++++---------------------------------
1 file changed, 35 insertions(+), 51 deletions(-)
diff --git a/README.md b/README.md
index 5a98dcae3..0250d920e 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,48 @@
-
PyElastica
+
+
PyElastica
[![Build_status][badge-travis]][link-travis] [![CI][badge-CI]][link-CI] [![Documentation Status][badge-docs-status]][link-docs-status] [![codecov][badge-codecov]][link-codecov] [![Downloads][badge-pepy-download-count]][link-pepy-download-count] [![Binder][badge-binder]][link-binder] [![Gitter][badge-gitter]][link-gitter]
-
+
+
PyElastica is the python implementation of **Elastica**: an *open-source* project for simulating assemblies of slender, one-dimensional structures using Cosserat Rod theory.
[![gallery][link-readme-gallary]][link-project-website]
Visit [cosseratrods.org][link-project-website] for more information and learn about Elastica and Cosserat rod theory.
-## Installation
-[![PyPI version][badge-pypi]][link-pypi]
+## How to Start
+[![PyPI version][badge-pypi]][link-pypi] [![Documentation Status][badge-docs-status]][link-docs-status]
-PyElastica is compatible with Python 3.6 - 3.8. The easiest way to install PyElastica is with PIP.
+PyElastica is compatible with Python 3.7 - 3.10.
~~~bash
$ pip install pyelastica
~~~
-## Documentation
-[![Documentation Status][badge-docs-status]][link-docs-status]
-
-Documentation of PyElastica is available [here][link-docs-website]
-
-## Tutorials
-[![Binder][badge-binder-tutorial]][link-binder]
+Documentation of PyElastica is available [here][link-docs-website].
-We have created several Jupyter notebooks and Python scripts to help users get started with PyElastica. The Jupyter notebooks are available on Binder, allowing you to try out some of the tutorials without having to install PyElastica.
+## Citation
-We have also included an example script for visualizing PyElastica simulations using POVray. This script is located in the examples folder ([`examples/visualization`](examples/visualization)).
+We ask that any publications which use Elastica cite as following:
-## Contribution
+```
+@misc{PyElastica,
+ author = {Arman Tekinalp, Seung Hyun Kim, Tejaswin Parthasarathy, Yashraj Bhosale},
+ title = {PyElastica: A computational framework for Cosserat rod assemblies},
+ year = {2022},
+ publisher = {GitHub},
+ journal = {GitHub repository},
+ howpublished = {\url{https://github.com/GazzolaLab/PyElastica}},
+}
+```
-If you would like to participate, please read our [contribution guideline](CONTRIBUTING.md)
+
+ References
+
+- Gazzola, Dudte, McCormick, Mahadevan, Forward and inverse problems in the mechanics of soft filaments, Royal Society Open Science, 2018. doi: [10.1098/rsos.171628](https://doi.org/10.1098/rsos.171628)
+- Zhang, Chan, Parthasarathy, Gazzola, Modeling and simulation of complex dynamic musculoskeletal architectures, Nature Communications, 2019. doi: [10.1038/s41467-019-12759-5](https://doi.org/10.1038/s41467-019-12759-5)
-PyElastica is developed by the [Gazzola Lab][link-lab-website] at the University of Illinois at Urbana-Champaign.
+
## List of publications and submissions
@@ -44,43 +53,18 @@ PyElastica is developed by the [Gazzola Lab][link-lab-website] at the University
- [Controlling a CyberOctopus soft arm with muscle-like actuation](https://arxiv.org/abs/2010.03368) (UIUC, 2020)
- [Energy shaping control of a CyberOctopus soft arm](https://ieeexplore.ieee.org/document/9304408) (UIUC, 2020) (IEEE CDC 2020)
-## Citation
+## Tutorials
+[![Binder][badge-binder-tutorial]][link-binder]
-We ask that any publications which use Elastica cite the following papers:
+We have created several Jupyter notebooks and Python scripts to help users get started with PyElastica. The Jupyter notebooks are available on Binder, allowing you to try out some of the tutorials without having to install PyElastica.
-Overall and for single rods:
-Gazzola, Dudte, McCormick, Mahadevan, Forward and inverse problems in the mechanics of soft filaments, Royal Society Open Science, 2018. doi: [10.1098/rsos.171628](https://doi.org/10.1098/rsos.171628)
-```
-@article{Gazzola2018,
- title={Forward and inverse problems in the mechanics of soft filaments},
- author={Gazzola, M and Dudte, LH and McCormick, AG and Mahadevan, L},
- journal={Royal Society open science},
- volume={5},
- number={6},
- pages={171628},
- year={2018},
- publisher={The Royal Society Publishing},
- doi = {10.1098/rsos.171628},
- url = {https://doi.org/10.1098/rsos.171628},
-}
-```
+We have also included an example script for visualizing PyElastica simulations using POVray. This script is located in the examples folder ([`examples/visualization`](examples/visualization)).
-For assemblies of rods:
-Zhang, Chan, Parthasarathy, Gazzola, Modeling and simulation of complex dynamic musculoskeletal architectures, Nature Communications, 2019. doi: [10.1038/s41467-019-12759-5](https://doi.org/10.1038/s41467-019-12759-5)
-```
-@article{Zhang2019,
- title={Modeling and simulation of complex dynamic musculoskeletal architectures},
- author={Zhang, X and Chan, FK and Parthasarathy, T and Gazzola, M},
- journal={Nature Communications},
- volume={10},
- number={1},
- pages={1--12},
- year={2019},
- publisher={Nature Publishing Group},
- doi = {10.1038/s41467-019-12759-5},
- url = {https://doi.org/10.1038/s41467-019-12759-5},
-}
-```
+## Contribution
+
+If you would like to participate, please read our [contribution guideline](CONTRIBUTING.md)
+
+PyElastica is developed by the [Gazzola Lab][link-lab-website] at the University of Illinois at Urbana-Champaign.
## Senior Developers ✨
_Names arranged alphabetically_
From 583c4aec28573d1c88442812a6cea92416d38939 Mon Sep 17 00:00:00 2001
From: Arman Tekinalp <53585636+armantekinalp@users.noreply.github.com>
Date: Thu, 28 Jul 2022 13:10:10 -0500
Subject: [PATCH 2/3] Update README.md
---
README.md | 13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 0250d920e..1063538d2 100644
--- a/README.md
+++ b/README.md
@@ -26,13 +26,12 @@ Documentation of PyElastica is available [here][link-docs-website].
We ask that any publications which use Elastica cite as following:
```
-@misc{PyElastica,
- author = {Arman Tekinalp, Seung Hyun Kim, Tejaswin Parthasarathy, Yashraj Bhosale},
- title = {PyElastica: A computational framework for Cosserat rod assemblies},
- year = {2022},
- publisher = {GitHub},
- journal = {GitHub repository},
- howpublished = {\url{https://github.com/GazzolaLab/PyElastica}},
+@misc{tekinalp2022pyelastica,
+ title={PyElastica: A computational framework for Cosserat rod assemblies},
+ author={Tekinalp, Arman and Kim, Seung Hyun and Parthasarathy, Tejaswin and Bhosale, Yashraj},
+ journal={https://github.com/GazzolaLab/PyElastica},
+ year={2022},
+ publisher={GitHub}
}
```
From f5db6ce3bad32c08faa851d8b948b649f8d7054f Mon Sep 17 00:00:00 2001
From: Seung Hyun Kim
Date: Wed, 17 Aug 2022 21:45:44 -0500
Subject: [PATCH 3/3] Create FAQs.md
---
docs/overview/FAQs.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
create mode 100644 docs/overview/FAQs.md
diff --git a/docs/overview/FAQs.md b/docs/overview/FAQs.md
new file mode 100644
index 000000000..3bd530f2d
--- /dev/null
+++ b/docs/overview/FAQs.md
@@ -0,0 +1,12 @@
+If you have a question not answered here, leave an issue on our [github-issue](https://github.com/GazzolaLab/PyElastica/issues).
+
+### Q. Is there support available for Elastica?
+
+If you open an issue on [GitHub](https://github.com/GazzolaLab/PyElastica), we will look and respond within 24-48 hours.
+
+
+
+[link-citation]: https://github.com/GazzolaLab/PyElastica#citation