Commit a4917eea authored by Philipp Reuber's avatar Philipp Reuber
Browse files

modify documentation

parent b437ccc6
Pipeline #250300 passed with stages
in 1 minute and 38 seconds
......@@ -9,7 +9,7 @@ For this export example we use the result from the import example. The whole exp
import_result = cimpy.cim_import(xml_files_abs, "cgmes_v2_4_15")
For the function cim_export a list containing all profiles which should be used for the export is needed. For more information about the arguments of the cim_export function see `Usage <https://acs.pages.rwth-aachen.de/public/cim/cimpy/Usage.html>`_.
For the function cim_export a list containing all profiles which should be used for the export is needed. For more information about the arguments of the cim_export function see `Functions <https://acs.pages.rwth-aachen.de/public/cim/cimpy/Functions.html>`_.
.. code-block:: python
......
......@@ -32,7 +32,7 @@ In the next step the files given in xml_files_abs are imported:
import_result = cimpy.cim_import(xml_files_abs, "cgmes_v2_4_15")
For more information about the function cim_import see `Usage <https://acs.pages.rwth-aachen.de/public/cim/cimpy/Usage.html>`_.
For more information about the function cim_import see `Functions <https://acs.pages.rwth-aachen.de/public/cim/cimpy/Functions.html>`_.
Finally we can print the created objects. In this example only objects of the classes ACLineSegment, PowerTransformer and EnergyConsumer are printed.
......
......@@ -14,7 +14,7 @@ For the installation of CIMpy take a look at the `installation instructions <htt
Getting Started
---------------
A quickstart guide with examples and explanations of the functions inside this package can be found `here <https://acs.pages.rwth-aachen.de/public/cim/cimpy/Usage.html>`__.
A quickstart guide with examples and explanations of the functions inside this package can be found `here <https://acs.pages.rwth-aachen.de/public/cim/cimpy/Start.html>`__.
Contact
......
Markdown is supported
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