restructure documentation (add Sphinx build files)

Former-commit-id: 592fe867

Documentation/.gitignore

+_build

Documentation/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = DPsim
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

Documentation/Shmem.md

-## Shared memory interface
-
-### Building
-
-Build libvillas-ext from [VILLASnode](https://git.rwth-aachen.de/VILLASframework/VILLASnode):
-
-```
-$ git clone git@git.rwth-aachen.de:VILLASframework/VILLASnode.git
-$ cd VILLASnode
-$ make
-# make install-libvillas-ext
-```
-
-There are also RPMs available for Fedora:
-
-```
-$ wget https://villas.fein-aachen.org/packages/villas.repo
-# mv villas.repo /etc/yum.repos.d
-# dnf -y install villas-node-devel
-```
-
-Then, build DPsim as normal.
-
-### Using the interface in simulations
-
-To use the interface in simulations, create `ExternalVoltageSource` or
-`ExternalCurrentSource` objects and register them with a `ShmemInterface`.
-Samples are passed between DPsim and the other process in an array of real numbers; you
-need to specify which elements from this array to use when registering a source.
-Similarly, you can register currents through specific components and voltages
-between nodes the be passed back to the other process. See the Doxygen documentation for
-`ShmemInterface` and `ExternalInterface` or the examples in `Examples/ShmemTest.cpp` for more information.
-
-### Running with VILLASnode
-
-To actually run simulations, start VILLASnode and DPsim, configuring them to use
-the other process' output queue as the input queue. If VILLASnode is running as root,
-DPsim needs to be started as root as well to connect to it. You may need to
-adjust `LD_LIBRARY_PATH` to include the directory where libvillas-ext was
-installed if you didn't install it to /usr/lib:
-
-```
-$ sudo env LD_LIBRARY_PATH=/usr/local/lib ./DPsolver
-```
-
-You can also use the `exec` option of the `shmem` node from VILLASnode; see its
-documentation for more details.
-
-### Direct communication between DPsim instances
-
-The shmem interfaces can also be used similarily for direct communication between
-2 instances of DPsim. For this, just start two instances of DPsim, each using
-a ShmemInterface with them directly using the other's output queue as the input
-queue. See `shmemDistributedExample` from `Examples/ShmemTest.cpp` for an example.

Documentation/conf.py

+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# DPsim documentation build configuration file, created by
+# sphinx-quickstart on Mon Sep 25 12:09:44 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'DPsim'
+copyright = '2017, Institute for Automation of Complex Power Systems, RWTH Aachen'
+author = 'Institute for Automation of Complex Power Systems, RWTH Aachen'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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.
+#
+# html_theme_options = {}
+
+# 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 = ['_static']
+
+# 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',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'DPsimdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'DPsim.tex', 'DPsim Documentation',
+     'Institute for Automation of Complex Power Systems, RWTH Aachen', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'dpsim', 'DPsim Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'DPsim', 'DPsim Documentation',
+     author, 'DPsim', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+default_role = 'any'

Documentation/index.rst

+.. dpsim documentation master file, created by
+   sphinx-quickstart on Fri Sep 22 16:22:46 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to dpsim's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   module
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

Documentation/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=DPsim
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

Documentation/module.rst

+Python module documentation
+===========================
+
+.. automodule:: dpsim
+    :members:

Source/PyInterface.cpp

@@ -69,7 +69,7 @@ PyObject* PyInterface::exportCurrent(PyObject* self, PyObject* args) {
 }
 
 const char* pyDocInterfaceExportVoltage =
-"export_voltage(from, to, real_idx, imag_idx)"
+"export_voltage(from, to, real_idx, imag_idx)\n"
 "Register a voltage between two nodes to be written to this interface after every timestep.\n"
 "\n"
 ":param from: Number of the positive node of the voltage to be exported. The same "