Commit fd975f42 authored by Markus Mirz's avatar Markus Mirz
Browse files

update README

parent d41839d2
......@@ -3,62 +3,34 @@
[![pipeline status](https://git.rwth-aachen.de/acs/public/simulation/dpsim/dpsim/badges/master/pipeline.svg)](https://git.rwth-aachen.de/acs/public/simulation/dpsim/dpsim/commits/master)
[![coverage report](https://git.rwth-aachen.de/acs/public/simulation/dpsim/dpsim/badges/master/coverage.svg)](https://git.rwth-aachen.de/acs/public/simulation/dpsim/dpsim/commits/master)
DPsim is a solver library for power system simulation.
DPsim is a solver library for dynamic power system simulation.
- It supports both the electro-magnetic transient (EMT) and dynamic phasor (DP) domain.
- It supports both the electromagnetic transient (EMT) and dynamic phasor (DP) domain for dynamic simulation.
- A powerflow solver is included standalone usage or initialization of dynamic simulations.
- It provides a Python module which can be embedded in any Python 3 application / scripts.
- It is implemented in highly-efficient C++ code.
- It supports real-time execution with time-steps up to 50 uS.
- The simulation core is implemented in highly-efficient C++ code.
- It supports real-time execution with time-steps down to 50 uS.
- It can load models in the IEC61970 Common Information Model (CIM) XML format.
- It can be interfaced to a variety of protocols and interfaces via [VILLASnode](http://www.fein-aachen.org/projects/villas-framework/).
## Installation
If you just want to use DPsim for simulations, take a look at the [installation instructions](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/dpsim/Install.html).
If you would like to modify / extend DPsim or build it for a specific platform, take a look at the [build instructions](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/dpsim/Build.html).
## Usage
DPsim is a Python extension module which is implemented in optimized native C++ code.
Users can control and script the simulation with Python scripts. Checkout the [Examples](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/dpsim/Examples.html).
- It can be interfaced to a variety of protocols and interfaces via [VILLASnode](https://fein-aachen.org/projects/villas-node/).
## Documentation
The [user documentation](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/dpsim/about.html) has examples, build / installation instructions and covers the Python API.
The C++ [developer documentation](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/dpsim/cxx/index.html) only includes automatically generated content using Doxygen.
It is helpful to understand the general structure of the C++ DPsim core components.
## Copyright
2017, Institute for Automation of Complex Power Systems, EONERC, RWTH Aachen University
The [documentation](https://dpsim.fein-aachen.org/) has build / installation instructions, links to examples and explains the concepts implemented in DPsim as well as its architecture.
## License
This project is released under the terms of the [GPL version 3](https://git.rwth-aachen.de/acs/public/simulation/dpsim/dpsim/blob/master/COPYING.md).
```
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```
Most of the DPsim source files are dual-licensed under the [MPL2](https://mozilla.org/MPL/2.0/) and [GPL3](http://www.gnu.org/licenses/).
The project is released under the terms of the GPL3 due to its dependency on VILLASnode.
For other licensing options please consult [Prof. Antonello Monti](mailto:amonti@eonerc.rwth-aachen.de).
For other licensing options, please consult [Prof. Antonello Monti](mailto:amonti@eonerc.rwth-aachen.de).
## Contact
- Markus Mirz <mmirz@eonerc.rwth-aachen.de>
- Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
- Jan Dinkelbach <jdinkelbach@eonerc.rwth-aachen.de>
[Institute for Automation of Complex Power Systems (ACS)](http://www.acs.eonerc.rwth-aachen.de)
[EON Energy Research Center (EONERC)](http://www.eonerc.rwth-aachen.de)
[RWTH University Aachen, Germany](http://www.rwth-aachen.de)
[Institute for Automation of Complex Power Systems (ACS)](http://www.acs.eonerc.rwth-aachen.de) \
[EON Energy Research Center (EONERC)](http://www.eonerc.rwth-aachen.de) \
[RWTH University Aachen, Germany](http://www.rwth-aachen.de)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment