INSTALL

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

These are generic installation instructions.

Dependences
===========

In order to be able to install and compile the QSS Solver, 
the following dependencies must be installed (Ubuntu 20.04): 

    * bison++
    * boost1.71
    * cmake 
    * g++
    * gfortran 
    * gnuplot
    * libatlas-base-dev
    * libcln-dev
    * libconfig-dev
    * libginac-dev
    * libgsl-dev
    * libsbml5-dev
    * libscotch-dev
    * libsuitesparse-dev
    * pkgconf
    * python
    * qt5-default
     
Basic Installation
==================

The simplest way to compile this package is:

  1. `cd` to the directory containing the package's source code and type
     `make` to compile the binaries and libraries.
  
  2. Type `make install` to install all the binary files and the libraries.
     The binaries are located in the bin folder and the libraries are located
     in the lib folder. 
  
  3. You can remove the program binaries and object files from the
     source code directory by typing `make clean`.  

Makefile options
================

The makefile script accepts the following options:

	* MODE = <Debug|Release> 	When set to Debug (default), adds the compiler's debug flags.
	
Makefile targets
================

The makefile script accepts the following targets:

	* qss-engine: 		Builds the QSS solver libraries.

	* mmo-compiler: 	Builds the MicroModelica compiler. 	

	* qss-solver-gui:	Builds the graphic interface.

	* qss-user-libs:	Builds the user packages included in this distribution.

	* mmo-interfaces:	Builds the SBML-MicroModelica translator. 

	* qss-solver-doc: Builds the documentation for the QSS solver libraries,
							the MicroModelica compiler and the QSS solver GUI.