Skip to content

Commit

Permalink
#173 Restructure documentation and fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
thSoft committed Feb 13, 2019
1 parent 48871aa commit 76d3f39
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ The <<user/api_usage_example#, *API usage guide*>> describes how to build your o
The <<user/simulink_ecore_metamodel#, *Simulink Ecore Metamodel*>>
describes how Massif represents Simulink models in EMF.


== For developers

See the https://github.com/viatra/massif/wiki[project wiki on GitHub].
30 changes: 0 additions & 30 deletions docs/hu.bme.mit.massif.doc/src/main/asciidoc/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,36 +34,6 @@ project funded by Embraer S.A.

Please let us know if you use Massif (e.g. open an https://github.com/viatra/massif/issues/new[issue])!

== Update site:
=== Prerequisites

* Release 0.4.0: EMF-IncQuery 0.8 http://download.eclipse.org/incquery/updates/release/
* Release 0.5.0: EMF-IncQuery 1.0 http://download.eclipse.org/incquery/updates/release/
* Release 0.6.0: VIATRA Query and Transformation SDK 1.7 http://download.eclipse.org/viatra/updates/release/1.7.2
* Release 0.7.0: VIATRA Query and Transformation SDK 2.0 http://download.eclipse.org/viatra/updates/release/2.0.0
* Upcoming release 0.8.0: VIATRA Query and Transformation SDK 2.1 http://download.eclipse.org/viatra/updates/release/2.1.0
* CI: VIATRA Query and Transformation SDK http://download.eclipse.org/viatra/updates/release/latest

=== Latest release: 0.7.0
Release: https://static.incquerylabs.com/projects/massif/release/0.7.0/repository

* Command evaluation server archive https://static.incquerylabs.com/projects/massif/release/0.7.0/massif.commandevaluation.server-0.7.0.zip[download]

=== All releases
Release composite site: https://static.incquerylabs.com/projects/massif/release

* Command evaluation server archive in folder of specific releases
https://static.incquerylabs.com/projects/massif/release/[download]

=== CI update site

We also provide a
https://build.incquerylabs.com/jenkins/job/Massif/job/master/lastSuccessfulBuild/artifact/releng/hu.bme.mit.massif.site/target/repository/[CI update site].

* Command evaluation server archive
https://build.incquerylabs.com/jenkins/job/Massif/job/master/lastSuccessfulBuild/artifact/releng/massif.commandevaluation.server-package/massif.commandevaluation.server.zip[download]
* CI Build on Jenkins: https://build.incquerylabs.com/jenkins/job/Massif/job/master/

== I. Installation

It is required to have the following tools:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ In the following sections code fragments are from the corresponding example clas

=== Headless usage (Massif in non-eclipse environment)
If you wish to use Massif in a non-eclipse environment, you have to run the following
setup, found in the 'hu.bme.mit.massif.simulink.cli' package:
setup, found in the `hu.bme.mit.massif.simulink.cli` package:
[source, java]
----
"CLIInitializationUtil.setupEnvironment()"
CLIInitializationUtil.setupEnvironment()
----

Also, the default VIATRA backends must be provided:
Expand Down Expand Up @@ -117,7 +117,7 @@ so it can be obtained by the `loadedModel.getSimulinkRef().getFQN()` call.
== Caveats

If a model is already loaded by Simulink, you can't re-import or re-export them.
Use the "bdclose('all')" simulink command to close all opened systems.
Use the `bdclose('all')` simulink command to close all opened systems.

It can be run via Massif programmatically:
[source, java]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ representation.
How this traversal is configured is defined in the model import preferences in
_Window/Preferences/Simulink Preferences/Model Import Preferences_.

image::/model_import_preferences.png[Model Import Preferences]
image::model_import_preferences.png[Model Import Preferences]

The available options are the followings:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,31 @@

As it is mostly apparent from its full name (Matlab Simulink Integration Framework for Eclipse), Massif is an Eclipse-based tool. For installing just follow these steps:

1. Download an Eclipse product from http://www.eclipse.org/downloads/ or use the [Eclipse installer](https://www.eclipse.org/downloads/packages/installer)
1. Download an Eclipse product from http://www.eclipse.org/downloads/ or use the https://www.eclipse.org/downloads/packages/installer[Eclipse installer]
2. Install EMF-IncQuery or VIATRA Query prerequisites:
* Check <<../overview#, Overview>> to see which version is needed.
2. Install EMF-IncQuery or VIATRA Query prerequisites from the appropriate update site
3. Install Massif Core components from the update site, see links on <<../overview#, Overview>>
* Massif Matlab Communication Providers are optional, depending on which <<matlab_connectors#, connector>> you would like to use to communicate with MATLAB.
* Release 0.4.0: EMF-IncQuery 0.8 http://download.eclipse.org/incquery/updates/release/
* Release 0.5.0: EMF-IncQuery 1.0 http://download.eclipse.org/incquery/updates/release/
* Release 0.6.0: VIATRA Query and Transformation SDK 1.7 http://download.eclipse.org/viatra/updates/release/1.7.2
* Release 0.7.0: VIATRA Query and Transformation SDK 2.0 http://download.eclipse.org/viatra/updates/release/2.0.0
* Upcoming release 0.8.0: VIATRA Query and Transformation SDK 2.1 http://download.eclipse.org/viatra/updates/release/2.1.0
* CI: VIATRA Query and Transformation SDK http://download.eclipse.org/viatra/updates/release/latest
3. Install Massif Core components from the appropriate update site
* Latest release: https://static.incquerylabs.com/projects/massif/release/0.7.0/repository
* All releases: https://static.incquerylabs.com/projects/massif/release
* CI: https://build.incquerylabs.com/jenkins/job/Massif/job/master/lastSuccessfulBuild/artifact/releng/hu.bme.mit.massif.site/target/repository/
4. (Optional) Depending on which <<matlab_connectors#, connector>> you would like to use to communicate with MATLAB, install also the appropriate Communication Provider Feature from the update site and the following additional components:
* Command Evaluation Server:
** https://static.incquerylabs.com/projects/massif/release/0.7.0/massif.commandevaluation.server-0.7.0.zip[Latest release]

** https://static.incquerylabs.com/projects/massif/release/[All releases]

** https://build.incquerylabs.com/jenkins/job/Massif/job/master/lastSuccessfulBuild/artifact/releng/massif.commandevaluation.server-package/massif.commandevaluation.server.zip[CI]
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

A possible way to work with Simulink is to parse the persisted model files.
As a well known major problem with this approach is that the format of the serialized models might change over time
(e.g., in 2012 suddenly the `.slx` format became default instead of the `.mdl`),
(e.g. in 2012 suddenly the `.slx` format became default instead of the `.mdl`),
causing extensive additional work to adapt to these changes for tools based on parsing serialized MATLAB file formats.
For this reason, Massif uses the Java interface of a running MATLAB and discovers the model using Simulink model
specific MATLAB commands.
Expand Down

0 comments on commit 76d3f39

Please sign in to comment.