# $Id: README 1437 2016-07-15 12:45:19Z klugeflo $

Requirements
============
The following packages must be installed:
>=sys-devel/gcc-4.7
>=dev-util/cmake-2.8.12
dev-libs/libxml2
dev-libs/boost
Multithreading support must be available for mkevals.

If you want to build the API documentation, additionally the following
packages are required:
app-doc/doxygen

If you want to build the Qt GUI (tms-vis), additionally the Qt4 libraries
must be installed.


Installation
============

$ cd build
$ ../build-local.sh ..
$ make
$ make install

Installs all binaries to build/bin

If you like to perform a system-wide installation, you can simply used
'cmake' instead of 'build-local.sh'. Currently, we recommend to
perform only a local (non system-wide) installation.

If you want tms-vis also to be built, pass "-DBUILD_GUI=1" to build-local.sh.
Beware that the tms-vis is providing only very basic functionality so far!


References
==========

If you are using tms-sim in your scientific work, please cite it as:

Florian Kluge. "tms-sim – Timing Models Scheduling Simulation Framework
 – Release 2016-07". Technical Report 2016-04, Department of Computer
Science, University of Augsburg, July 2016.
http://www.informatik.uni-augsburg.de/lehrstuehle/sik/publikationen/reports/2016_04_klu/

Further publications related to tms-sim:

Florian Kluge. Notes on the Generation of Spin-Values for Fixed (m,k)-Patterns.
Technical Report 2016-01, Department of Computer Science, University of
Augsburg, January 2016.
https://www.informatik.uni-augsburg.de/de/lehrstuehle/sik/publikationen/reports/2016_01_klu/

Florian Kluge, Markus Neuerburg, Theo Ungerer. Utility-based scheduling of
(m,k)-Firm Real-Time Task Sets. In 28th GI/ITG International Conference on
Architecture of Computing Systems (ARCS 2015).
https://www.informatik.uni-augsburg.de/lehrstuehle/sik/publikationen/papers/2015_arcs_klu/

Florian Kluge. tms-sim - Timing Models Scheduling Simulation Framework,
Release 2014-12. Technical Report 2014-07, Universität Augsburg.
http://www.informatik.uni-augsburg.de/lehrstuehle/sik/publikationen/reports/2014_12_klu/

Florian Kluge, Mike Gerdes, Florian Haas, Theo Ungerer. A Generic Timing Model
for Cyber-Physical Systems. In Workshop on Reconciling Predictability and
Performance (RePP'14).
http://www.informatik.uni-augsburg.de/lehrstuehle/sik/publikationen/papers/2014_repp_klu/

Florian Kluge, Florian Haas, Mike Gerdes, Theo Ungerer. History-Cognisant
Time-Utility-Functions for Scheduling Overloaded Real-Time Control Systems.
In Proceedings of 7th Junior Researcher Workshop on Real-Time Computing
(JRWRTC 2013).
http://www.informatik.uni-augsburg.de/lehrstuehle/sik/publikationen/papers/2013_jrwrtc_klu/