Skip to content

Commit 136741c

Browse files
committed
Modified the README.md
1 parent 295e4d7 commit 136741c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
11
# OpenModal
2-
Open source experimental modal analysis software.
2+
OpenModal is an open source experimental modal analysis software written in Python.
3+
4+
OpenModal combines geometry builder, measurement, identification and animation module to aid in experimental analysis of the dynamic properties of structures. It is written in Python and published under the GPL license.
5+
6+
## Running the software
7+
In order to develop the software on the same Python version and the corresponding library versions,
8+
a virtual environment is created in the folder *virtual-environment*.
9+
10+
To run the virtual environment on Windows PowerShell, execute the following commands:
11+
12+
```
13+
.\virtual-environment\Scripts\Activate.ps1
14+
```
15+
16+
This should set the environment to `Python 3.6` and to the `PyQt4` and the associated librraries.
17+
18+
To run the software, execute the following:
19+
20+
```
21+
cd openModal/
22+
python openmodal.py
23+
```
24+
25+
## Support the project
26+
If you are interested in contributing to the code base or just by supporting the project, send us an e-mail to [email protected].

0 commit comments

Comments
 (0)