You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
<imgsrc="logo/STONEHENGE.png"width="40%">
1
+
## Suite for Nonlinear Analysis of Energy Harvesting Systems
2
2
3
3
**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.
4
4
5
-
## Table of Contents
5
+
###Table of Contents
6
6
-[Overview](#overview)
7
7
-[Features](#features)
8
8
-[Usage](#usage)
@@ -16,17 +16,17 @@
16
16
-[Contact](#contact)
17
17
-[References using STONEHENGE](#references-using-stonehenge)
18
18
19
-
## Overview
19
+
###Overview
20
20
**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. <ahref="http://dx.doi.org/10.1016/j.simpa.2021.100161"target="_blank">DOI</a>
22
22
23
-
## Features
23
+
###Features
24
24
- Comprehensive nonlinear dynamic analysis of energy harvesting systems
25
25
- Simulation, optimization, control, and visualization tools
26
26
- Robust framework for numerical experimentation
27
27
- Fully reproducible simulations
28
28
29
-
## Usage
29
+
###Usage
30
30
To get started with **STONEHENGE**, follow these steps:
31
31
1. Clone the repository:
32
32
```bash
@@ -39,13 +39,13 @@ To get started with **STONEHENGE**, follow these steps:
39
39
40
40
**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.
41
41
42
-
## Documentation
42
+
###Documentation
43
43
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.
44
44
45
-
## Reproducibility
45
+
###Reproducibility
46
46
Simulations done with **STONEHENGE** are fully reproducible. You can find a fully reproducible capsule of the simulations on <ahref="https://codeocean.com/capsule/4891890/tree/v1"target="_blank">CodeOcean</a>.
47
47
48
-
## Authors
48
+
###Authors
49
49
- João Pedro C. V. Norenberg
50
50
- João Victor L. L. Peterson
51
51
- Vinicius G. Lopes
@@ -55,7 +55,7 @@ Simulations done with **STONEHENGE** are fully reproducible. You can find a full
55
55
- José Geraldo Telles Ribeiro
56
56
- Americo Cunha Jr
57
57
58
-
## Citing STONEHENGE
58
+
###Citing STONEHENGE
59
59
If you use **STONEHENGE** in your research, please cite the following publication:
60
60
-*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*
61
61
@@ -67,31 +67,31 @@ If you use **STONEHENGE** in your research, please cite the following publicatio
For any questions or further information, please contact the authors at:
90
90
91
91
- João Pedro C. V. Norenberg: jpcvalese@gmail.com
92
92
- Americo Cunha Jr: americo.cunha@uerj.br
93
93
94
-
## References using STONEHENGE
94
+
###References using STONEHENGE
95
95
The following references used **STONEHENGE** to obtain their results. If you want to see your publication listed here, please contact us.
96
96
97
97
-**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