diff --git a/README.md b/README.md index a9536e842..2f1bf4474 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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).
-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. diff --git a/ci/README.md b/ci/README.md deleted file mode 100644 index fb298b279..000000000 --- a/ci/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# CI Repository Mirroring - -This script clones the "bare" Repository with all of its branches from Gitlab and pushes it to Github. -Authentication to the remotes is ensured through access-tokens passed to the runner. -The `GITHUB_TOKEN` must be granted write access to the target remote. -Tokens and the username for https-authentikation are stored as Secret-CI-Variables (Settings -> CI/CD -> Secret Variables). - -.gitlab-ci.yml (in repository-root) starts an docker:git container on an docker-enabled CI-Runner for this project. - -## Secret Variables -|Name |Value | -|--- |--- | -|GIT_USER |git user for both GitLab & GitHub | -|GITLAB_TOKEN |accesstoken for GitLab | -|GITHUB_TOKEN |accesstoken for GitHub | - - -## Mirroring a whole Repository - -``` -git clone --mirror -cd -git push --mirror -``` - diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 6a79aec6e..c003a5e03 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -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 diff --git a/doc/acs_eonerc_logo.svg b/doc/acs_eonerc_logo.svg deleted file mode 100644 index cd1a34370..000000000 --- a/doc/acs_eonerc_logo.svg +++ /dev/null @@ -1,267 +0,0 @@ - - - -image/svg+xml \ No newline at end of file diff --git a/doc/all_logos.svg b/doc/all_logos.svg deleted file mode 100644 index 1c808c1c2..000000000 --- a/doc/all_logos.svg +++ /dev/null @@ -1,1231 +0,0 @@ - - - -image/svg+xml \ No newline at end of file diff --git a/doc/fein_black.svg b/doc/fein_black.svg deleted file mode 100644 index 4d4444548..000000000 --- a/doc/fein_black.svg +++ /dev/null @@ -1,1463 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Förderer der Energie- und Informationstechnikfür zukünftige Netze Aachen e.V. - - diff --git a/doc/header.html b/doc/header.html index b01a08a7b..edcdf7d49 100644 --- a/doc/header.html +++ b/doc/header.html @@ -47,13 +47,6 @@ - - - - Logo - - - $searchbox diff --git a/doc/style.css b/doc/style.css index 069249785..2583fae62 100644 --- a/doc/style.css +++ b/doc/style.css @@ -6,11 +6,3 @@ height: 3.5em; margin: 0.25em; } - -#institutelogo img { - height: 3em; - margin: 0.5em; - position: absolute; - right: 0; - top: 0; -}