Skip to content

Commit

Permalink
cleanup documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Mirz <markus.mirz@rwth-aachen.de>
  • Loading branch information
m-mirz committed Mar 25, 2024
1 parent 6396aff commit 66a9e24
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 3,033 deletions.
47 changes: 16 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,32 @@
libcimpp
========
libcimpp is a deserialiser library for C++ objects from XML/RDF documents based on the Common Information Model (CIM) standards (i.e. IEC61970/61968/62325) for the energy sector.
libcimpp is a deserialiser library for C++ objects from XML/RDF documents based on the Common Information Model (CIM) standards (i.e. IEC61970/61968/62325) and CGMES for the energy sector.
It is part of the CIM++ project. More on CIM++ can be found [here](http://rdcu.be/vOop).

CIM C++ Codebases adaptiert durch CIM++
Originale CIM Versionen


[IEC61970 16v29a](https://sogno-platform.github.io/libcimpp/IEC61970_16v29a/annotated.html)

[ICGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)

[IEC61970_16v29a_IEC61968_12v08](https://sogno-platform.github.io/libcimpp/IEC61970_16v29a_IEC61968_12v08/annotated.html)

[IEC61970_17v07](https://sogno-platform.github.io/libcimpp/IEC61970_17v07/annotated.html)

Supported CIM / CGMES versions:
- [CGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)
- [IEC61970 16v29a](https://sogno-platform.github.io/libcimpp/IEC61970_16v29a/annotated.html)
- [IEC61970_16v29a_IEC61968_12v08](https://sogno-platform.github.io/libcimpp/IEC61970_16v29a_IEC61968_12v08/annotated.html)
- [IEC61970_17v07](https://sogno-platform.github.io/libcimpp/IEC61970_17v07/annotated.html)

## General information
limcimpp uses [arabica](http://www.jezuk.co.uk/cgi-bin/view/arabica) as cross platform wrapper around one of the XML parsers listed int the dependencies (see below).
limcimpp uses [arabica](http://www.jezuk.co.uk/cgi-bin/view/arabica) as cross platform wrapper around one of the XML parsers listed in the dependencies (see below).
It is recommended to use libcimpp as cmake module.

## Dependencies
You need following software packages for libcimpp:
+ One of the following XML parsers:
+ [libxml2](http://www.xmlsoft.org/) (usually chosen under Linux and often can be installed as a package of the used distribution)
+ [expat](http://expat.sourceforge.net/)
+ [Xerces](http://xerces.apache.org/xerces-c/)
+ [Microsoft XML Parser](https://support.microsoft.com/en-en/help/324460) (this one is used per default when building with MS Visual Studio)
+ Build system:
+ [cmake](https://cmake.org/)

## Get the Git repository
```bash
git clone https://github.com/RWTH-ACS/libcimpp.git
cd libcimpp
git submodule update --init --recursive
```

## Build instructions
### The UNIX / Linux / MacOS way

### UNIX / Linux / MacOS

After getting the Git repository, create a build subdirectory and change into it:
```bash
mkdir build
Expand All @@ -56,9 +44,10 @@ For building libcimpp with a certain CIM version (e.g. `IEC61970_16v29a`), type:
cmake .. -DUSE_CIM_VERSION=IEC61970_16v29a
make -j 4
```
All available CIM versions can be determined in the [CMakeLists.txt](CMakeLists.txt)

### The Windows way with MS Visual Studio
All available CIM versions are listed in the [CMakeLists.txt](CMakeLists.txt)

### Windows with MS Visual Studio
1. After getting the Git repository, create a `build` subdirectory.
2. Run the Windows CMake (GUI)
3. Set the
Expand All @@ -70,11 +59,7 @@ All available CIM versions can be determined in the [CMakeLists.txt](CMakeLists.
7. Click on `Open Project` to open the project in Visual Studio.
8. In Visual Studio's main menu choose `Build -> Build Solution`. This will build the `libcimpp` library.

### Build instructions for using libcimpp as a cmake module
To be continued...


## Usage of the libcimpp library
For information how to use the library please see the [cmake based example](https://git.rwth-aachen.de/acs/core/cim/cimpp/libcimpp/tree/master/examples/cmake).
Building of the example can be performed analogous to bulding the library itself (as described in the *Build instructions* above).<br>
The pure make example is currently not supported due to the lack of an install target for arabica.
For information on how to use the library please see the cmake based example in examples/cmake.
Building the example is just like building the library itself using cmake.
The make example is currently not supported due to the lack of an install target for arabica.
25 changes: 0 additions & 25 deletions ci/README.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ DOT_GRAPH_MAX_NODES = 200

HTML_HEADER = doc/header.html
HTML_EXTRA_STYLESHEET = doc/style.css
HTML_EXTRA_FILES = doc/all_logos.svg
267 changes: 0 additions & 267 deletions doc/acs_eonerc_logo.svg

This file was deleted.

Loading

0 comments on commit 66a9e24

Please sign in to comment.