Skip to content

Commit 356dadc

Browse files
Update README.md
1 parent defd64a commit 356dadc

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<img src="logo/STONEHENGE.png" width="40%">
1+
## Suite for Nonlinear Analysis of Energy Harvesting Systems
22

33
**STONEHENGE - Suite for Nonlinear Analysis of Energy Harvesting Systems** is an ensemble of easy-to-run Matlab and C++ codes for the nonlinear dynamic analysis of vibration energy harvesting systems. It encompasses several tools to simulate, optimize, control, and visualize their dynamics, providing a broad and robust framework for numerical experimentation.
44

5-
## Table of Contents
5+
### Table of Contents
66
- [Overview](#overview)
77
- [Features](#features)
88
- [Usage](#usage)
@@ -16,17 +16,17 @@
1616
- [Contact](#contact)
1717
- [References using STONEHENGE](#references-using-stonehenge)
1818

19-
## Overview
19+
### Overview
2020
**STONEHENGE** was developed to conduct nonlinear analysis on bistable piezoelectric-magneto-elastic energy harvesters. The code functionalities are reported in the following publication:
21-
- **J. P. Norenberg, J. V. L. L. Peterson, V. G. Lopes, R. Luo, L. de la Roca, M. Pereira, J. G. Telles Ribeiro, A. Cunha Jr**, *STONEHENGE - Suite for Nonlinear Analysis of Energy Harvesting Systems*, Software Impacts, vol. 10, pp. 100161, 2021.
21+
- **J. P. Norenberg, J. V. L. L. Peterson, V. G. Lopes, R. Luo, L. de la Roca, M. Pereira, J. G. Telles Ribeiro, A. Cunha Jr**, *STONEHENGE - Suite for Nonlinear Analysis of Energy Harvesting Systems*, Software Impacts, vol. 10, pp. 100161, 2021. <a href="http://dx.doi.org/10.1016/j.simpa.2021.100161" target="_blank">DOI</a>
2222

23-
## Features
23+
### Features
2424
- Comprehensive nonlinear dynamic analysis of energy harvesting systems
2525
- Simulation, optimization, control, and visualization tools
2626
- Robust framework for numerical experimentation
2727
- Fully reproducible simulations
2828

29-
## Usage
29+
### Usage
3030
To get started with **STONEHENGE**, follow these steps:
3131
1. Clone the repository:
3232
```bash
@@ -39,13 +39,13 @@ To get started with **STONEHENGE**, follow these steps:
3939

4040
**STONEHENGE** can be used to simulate, optimize, control, and visualize the dynamics of bistable piezoelectric-magneto-elastic energy harvesters. Detailed usage instructions and examples are provided within the code comments and the provided documentation.
4141

42-
## Documentation
42+
### Documentation
4343
The routines in **STONEHENGE** are well-commented to explain their functionality. Each routine includes a description of its purpose, as well as inputs and outputs. Detailed documentation can be found within the code comments. An user-manual is available showing the package functionalities.
4444

45-
## Reproducibility
45+
### Reproducibility
4646
Simulations done with **STONEHENGE** are fully reproducible. You can find a fully reproducible capsule of the simulations on <a href="https://codeocean.com/capsule/4891890/tree/v1" target="_blank">CodeOcean</a>.
4747

48-
## Authors
48+
### Authors
4949
- João Pedro C. V. Norenberg
5050
- João Victor L. L. Peterson
5151
- Vinicius G. Lopes
@@ -55,7 +55,7 @@ Simulations done with **STONEHENGE** are fully reproducible. You can find a full
5555
- José Geraldo Telles Ribeiro
5656
- Americo Cunha Jr
5757

58-
## Citing STONEHENGE
58+
### Citing STONEHENGE
5959
If you use **STONEHENGE** in your research, please cite the following publication:
6060
- *J. P. Norenberg, J. V. L. L. Peterson, V. G. Lopes, R. Luo, L. de la Roca, M. Pereira, J. G. Telles Ribeiro, A. Cunha Jr, STONEHENGE - Suite for Nonlinear Analysis of Energy Harvesting Systems, Software Impacts, 10:100161, 2021 http://dx.doi.org/10.1016/j.simpa.2021.100161*
6161

@@ -67,31 +67,31 @@ If you use **STONEHENGE** in your research, please cite the following publicatio
6767
journal = {Software Impacts},
6868
volume. = {10},
6969
pages = {100161},
70-
note = {http://dx.doi.org/10.1016/j.simpa.2021.100161},
70+
note = {10.1016/j.simpa.2021.100161},
7171
}
7272
```
7373

74-
## License
74+
### License
7575

7676
**STONEHENGE** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.
7777

7878
<img src="logo/mit_license_red.png" width="10%">
7979

80-
## Institutional support
80+
### Institutional support
8181

8282
<img src="logo/logo_uerj_color.jpeg" width="10%"> &nbsp; &nbsp; <img src="logo/logo_unesp_color.png" width="20%">
8383

84-
## Funding
84+
### Funding
8585

8686
<img src="logo/faperj.jpg" width="20%"> &nbsp; &nbsp; <img src="logo/cnpq.png" width="20%"> &nbsp; &nbsp; <img src="logo/capes.png" width="10%">
8787

88-
## Contact
88+
### Contact
8989
For any questions or further information, please contact the authors at:
9090

9191
- João Pedro C. V. Norenberg: jpcvalese@gmail.com
9292
- Americo Cunha Jr: americo.cunha@uerj.br
9393

94-
## References using STONEHENGE
94+
### References using STONEHENGE
9595
The following references used **STONEHENGE** to obtain their results. If you want to see your publication listed here, please contact us.
9696

9797
- **J. P. Norenberg, and A. Cunha Jr**, *Vibration mitigation and energy harvesting with bistable resonators in metamaterial beams*, In: 27th International Congress on Mechanical Engineering (COBEM 2023), Florianópolis. Proceedings of COBEM 2023, 2023.

0 commit comments

Comments
 (0)