Merge branch 'master' into update-0.3.0

README.md

@@ -1,39 +1,47 @@
-<div align='center'> <h1> PyElastica </h1> </div>
+<div align='center'>
+<h1> PyElastica </h1>
 
 [![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]
-
+ </div>
+
 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.7 - 3.10. 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{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}
+}
+```
 
-If you would like to participate, please read our [contribution guideline](CONTRIBUTING.md)
+<details>
+  <summary><h4>References</h4></summary>
+
+- Gazzola, Dudte, McCormick, Mahadevan, <strong>Forward and inverse problems in the mechanics of soft filaments</strong>, Royal Society Open Science, 2018. doi: [10.1098/rsos.171628](https://doi.org/10.1098/rsos.171628)
+- Zhang, Chan, Parthasarathy, Gazzola, <strong>Modeling and simulation of complex dynamic musculoskeletal architectures</strong>, 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.
+</details>
 
 ## List of publications and submissions
 
@@ -44,43 +52,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, <strong>Forward and inverse problems in the mechanics of soft filaments</strong>, 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, <strong>Modeling and simulation of complex dynamic musculoskeletal architectures</strong>, 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_

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.
+
+<!--
+### Q2. Do PyElastica and Elastica++ have the same features?
+Almost. Due to development cycles, they may not always be equally up to date. If there is a feature in one that you would like to see in the other, let us know on [GitHub](https://github.com/GazzolaLab/PyElastica). 
+-->
+
+[link-citation]: https://github.com/GazzolaLab/PyElastica#citation