Skip to content

benvautrin/pmuc

Repository files navigation

Plant Mock-Up Converter

Build Status Build status

Copyright © EDF 2013-2019

About

This project contains a reading library for the RVM file format and a command line utility that allows to convert RVM files to

License (LGPL)

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

See the LICENSE.txt file for details.

How to Build

Prerequisites

PMUC uses the C++ 17 library feature std::variant, hence it requires a g++ compiler >= 7, MSVC 19.10 (Visual Studio 2017), or Clang 10.0 is required. Other platforms / compilers / IDEs have not been tested but are likely to work as well (please file an issue if not).

Building requires a cmake version >= 3.12.

Dependencies

Most dependencies are included in git submodules, namely eigen, OpenCOLLADA, and xiot. To inititalize the submodules, run:

git submodule init
git submodule update

Soley boost (on windows 1.69 is required, otherwise 1.65.1) needs to be provided externally. On Linux it is sufficient to install the boost development package, e.g.:

sudo apt-get install libboost-all-dev

On other systems, let the environment varaible ``BOOST_ROOT```point to Boost root directory.

Run the build

Windows

Run cmake from a different directory than your source (e.g. in a build folder) and select the generator of your choice, e.g.:

cmake -G "Visual Studio 14 2015 Win64" ..

Open the generated IDE file (pmuc.sln) or start the build from command line:

cmake --build . --target pmuc --config Release

Linux

Run:

mkdir build && cd build && cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . --target pmuc

Running Tests

PMUC includes a number of running tests that can be run from the build directory using ctest:

ctest -C Release --output-on-failure

Credit

This work has been led and founded by EDF DIN. It has been based on an analysis made by Kristian Sons from Supporting GmbH.

See the AUTHORS.txt file for details.