Commit 8be03b68 authored by Markus Mirz's avatar Markus Mirz
Browse files

Merge branch 'doc-gitlab-links' into 'master'

Doc gitlab links

See merge request acs/public/simulation/dpsim!132
parents b71429e5 160b64d2
set(CPACK_PACKAGE_NAME ${PROJECT_NAME})
set(CPACK_PACKAGE_VENDOR ${PROJECT_AUTHOR})
set(CPACK_PACKAGE_CONTACT "Steffen Vogel <stvogel@eonerc.rwth-aachen.de")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Dynamic Phasor simulation library in C++")
set(CPACK_PACKAGE_VERSION ${DPSIM_SHORT_VERSION})
set(CPACK_PACKAGE_VERSION_MAJOR ${DPSIM_MAJOR_VERSION})
set(CPACK_PACKAGE_VERSION_MINOR ${DPSIM_MINOR_VERSION})
......@@ -12,7 +11,6 @@ set(CPACK_RPM_PACKAGE_VERSION ${DPSIM_VERSION})
set(CPACK_RPM_PACKAGE_RELEASE ${DPSIM_RELEASE})
set(CPACK_RPM_PACKAGE_ARCHITECTURE "x86_64")
set(CPACK_RPM_PACKAGE_LICENSE "GPLv3")
set(CPACK_RPM_PACKAGE_URL "http://www.fein-aachen.org/projects/dpsim/")
set(CPACK_RPM_PACKAGE_REQUIRES "libcimpp16v29a libvillas graphviz python3-libs python3 python3-pip")
set(CPACK_RPM_PACKAGE_GROUP "Development/Libraries")
......
......@@ -18,7 +18,10 @@ add_definitions(-D_SILENCE_ALL_CXX17_DEPRECATION_WARNINGS)
set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/CMake;${PROJECT_SOURCE_DIR}/Dependencies/libcps/CMake")
set(PROJECT_AUTHOR "Institute for Automation of Complex Power Systems, RWTH Aachen University")
set(PROJECT_COPYRIGHT "2017, Institute for Automation of Complex Power Systems, RWTH Aachen University")
set(PROJECT_COPYRIGHT "2017-2020, Institute for Automation of Complex Power Systems, RWTH Aachen University")
set(PROJECT_DESCRIPTION "C++ Power System Simulation Library")
set(PROJECT_HOMEPAGE_URL "http://www.fein-aachen.org/projects/dpsim/")
set(PROJECT_VCS_URL "https://git.rwth-aachen.org/acs/public/simulation/dpsim")
include(CheckCXXCompilerFlag)
if(MSVC)
......
......@@ -18,7 +18,7 @@ It is helpful to understand the general structure of the C++ DPsim core componen
## Copyright
2017, Institute for Automation of Complex Power Systems, EONERC, RWTH Aachen University
2017-2020, Institute for Automation of Complex Power Systems, EONERC, RWTH Aachen University
## License
......
......@@ -3,7 +3,44 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. mdinclude:: README.md
DPsim
======
DPsim is a solver library for power system simulation.
- It supports both the electro-magnetic transient (EMT) and dynamic phasor (DP) domain.
- 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.
- It can load models in the `Common Information Model (CIM) <https://en.wikipedia.org/wiki/Common_Information_Model_%28electricity%29>`__ 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://dpsim.fein-aachen.org/doc/master/sphinx/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://dpsim.fein-aachen.org/doc/master/sphinx/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://dpsim.fein-aachen.org/doc/master/sphinx/Examples.html>`__.
Documentation
-------------
The `user documentation <http://dpsim.fein-aachen.org/doc/master/sphinx/>`__ has examples, build / installation instructions and covers the Python API.
The C++ `developer documentation <http://dpsim.fein-aachen.org/doc/master/doxygen/>`__ only includes automatically generated content using Doxygen.
It is helpful to understand the general structure of the C++ DPsim core components.
Contact
-------------
- `Markus Mirz <mmirz@eonerc.rwth-aachen.de>`__
- `Steffen Vogel <stvogel@eonerc.rwth-aachen.de>`__
.. toctree::
:maxdepth: 2
......@@ -14,6 +51,3 @@
Build
Real-time
Reference
License <Copying>
Changelog
......@@ -31,16 +31,21 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc', 'm2r', 'breathe', 'nbsphinx' ]
extensions = [
'sphinx.ext.autodoc',
# 'm2r',
# 'breathe',
'nbsphinx'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']
#source_suffix = '.rst'
#source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'Index'
......@@ -83,40 +88,49 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# Theme: Alabaster
#html_theme_options = {
# 'show_related' : True,
# 'show_powered_by' : False,
#
html_theme_options = {
'show_related' : True
}
# 'description' : '@PROJECT_DESCRIPTION@',
# 'donate_url': 'https://www.fein-aachen.org/contact/',
#
# # Matching to FEIN e.V. Website
# 'anchor' : '#a70404',
# 'anchor_hover_fg' : '#0085a1'
#}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = [ ]
html_logo = '@CMAKE_CURRENT_SOURCE_DIR@/images/dpsim.png'
#html_logo = '@CMAKE_CURRENT_SOURCE_DIR@/images/dpsim.png'
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
]
}
#html_sidebars = {
# '**': [
# 'about.html',
# 'navigation.html',
# 'relations.html', # needs 'show_related': True theme option to display
# 'searchbox.html',
# 'donate.html',
# ]
#}
html_context = {
'source_url_prefix': "https://git.rwth-aachen.org/acs/core/simulation/DPsim/HEAD/Documentation/",
'source_url_prefix': "@PROJECT_VCS_URL@/Documentation/",
}
......@@ -172,11 +186,10 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'DPsim', '@SPHINX_TITLE@',
author, 'DPsim', 'One line description of project.',
author, 'DPsim', '@PROJECT_DESCRIPTION@',
'Miscellaneous'),
]
default_role = 'any'
# -- Options for Breathe -------------------------------------------
......@@ -186,4 +199,12 @@ default_role = 'any'
# -- Options for nbsphinx
nbsphinx_execute = 'never'
\ No newline at end of file
nbsphinx_execute = 'never'
# -- sphinxcontrib-srclinks
# See: https://pypi.org/project/sphinxcontrib-srclinks/
vcs_url = '@PROJECT_VCS_URL@'
vcs_doc_path = 'Documentation/'
vcs_branch = '@DPSIM_GIT_BRANCH@'
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