Skip to content

Commit

Permalink
Modified INSTALL and README files.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaquinffernandez committed Oct 17, 2017
1 parent 40d8681 commit c10135e
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 47 deletions.
28 changes: 16 additions & 12 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -37,34 +37,38 @@ The simplest way to compile this package is:
The binaries are located in the bin folder and the libraries are located
in the lib folder.

3.

2. You can remove the program binaries and object files from the
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:
The makefile script accepts the following options:

* DEBUG = <True|False> If True, adds the compiler's debug flags. Default value False.

* OS=<unix|win32|mac> Select the target OS. Default value unix.

* CORES=<n> In a multicore machine, select the number of cores used to
* CORES= <n> In a multicore machine, select the number of cores used to
compile the solver. Default value 1.

* ACCESS= <HTTPS|SSH> Clone the repositories using HTPPS or SSH access to the server.
Default value HTTPS.

Makefile targets
================

The makefile script accepts the following targets:
The makefile script accepts the following targets:

* qss-engine: Builds the QSS solver libraries.

* qss-compiler: Builds the MicroModelica compiler.
* mmo-compiler: Builds the MicroModelica compiler.

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

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

* qss-gui: Builds the graphic interface.
* mmo-interfaces: Builds the SBML-MicroModelica translator.

* qss-user: Builds the user packages included in this distribution.
* qss-solver-doc: Builds the documentation for the QSS solver libraries,
the MicroModelica compiler and the QSS solver GUI.

* qss-tools: Builds the SBML-MicroModelica translator.
* clean-repos: Delete all the repositories.
65 changes: 30 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,36 @@
QSS Solver 3.1
QSS Solver 3.2
--------------

The QSS Solver is a modeling and simulation environment for
continuous and hybrid systems.

Models are described using a subset of the Modelica language
called MicroMoledica (http://www.fceia.unr.edu.ar/
control/modelica/micromodelicaspec.pdf).

Simulations can be performed using one of the following integration methods:

* QSS methods (the entire family is supported)
* DASSL
* DOPRI

New Features
------------

* Parallel simulation is supported for Linux platform.

* Modelica User Defined Functions (UDF) are now supported (including external C functions).

* The Modelica Package class containing UDF's is now supported.

* 'for' statements can be used in "event handler" definitions, i.e. inside 'when' and
'elsewhen' statements.

* Modelica array element-wise operations are supported (.+,.-,.*,./).

* Modelica reduction operations for arrays are supported:
- sum
- product
- min
- max
- *

* Classic numerical integration methods DASSL and DOPRI can be used to run simulations.
continuous and hybrid systems and it's optimized for large scale model simulation.
The solver is implemented as a set of modules coded in plain C language,
simulations can be performed using one of the following integration methods:

* QSS methods (the entire family is supported)
* DASSL
* DOPRI
* CVODE
* IDA

Models are described using a subset of the standard Modelica language called μ–Modelica
(the language specification can be found in
http://www.cifasis-conicet.gov.ar/jfernandez/micromodelica/micromodelicaspec.pdf),
the compiler extracts all the structural information needed and
automatically generates the plain C code that contains an appropiate
model definition needed by the
QSS Solver engine together with all the configuration files (makefiles, config, etc.).

The QSS Solver has a simple GUI interface that allows the end-user
to access all the developed tools in a unified way.

The GUI has the following features:

* It has a text editor, where models in μ-Modelica can be defined.
* It invokes the corresponding tools to compile and run simulations.
* It provides debug information in case of errors during the model generation.
* It invokes GnuPlot to plot the simulation output trajectories.
* It shows statistics about simulations (number of steps, simulation time,
etc.).

Installation
------------
Expand Down

0 comments on commit c10135e

Please sign in to comment.