Skip to content

saschpe/masonry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Masonry

A graphical tool to visualize and compute signal-flow graphs (or Mason graphs) written in C++ with Qt which uses either Matlab (commercial) or GNU Octave as the computational backend. It serves as a fully interactive editor to signal-flow graphs and allows you to run additional custom Matlab/Octave scripts as well as saving your graph files and results.


Prerequisites

This project uses Git as the revision-control system. Git is optional if you retrieved this project as a source tarball and is only useful if you plan to further develop the project or to send patches. The following software is necessary to build this application:

  • CMake 2.6 or later
  • Qt 4.6 or later

Additionally, one of the following software packages is needed to run the application (only one required):

  • Matlab r2008a or later (preferred, commercial)
  • GNU Octave 3.2 or later (default, free)

Installation

How to build masonry depends on your platform. Generally you have to use CMake to generate a platform-dependent build-environment. You can do that like this (in a terminal session):

$ mkdir build/
$ cd build/
$ cmake -DCMAKE_INSTALL_PREFIX=../dist ..

If you want to specify an optimised build, the following commands could be used instead:

$ mkdir build/ dist/
$ cd build/
$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../dist ..

You should now have either a Makefile on Unix-like operating systems or a Visual Studio project on Windows. You can now build and install the project by using Visual Studio (on Windows) or by issuing these commands (on Unix):

$ make
$ make install

The exact build procedure may differ slightly on your platform. Have a look at the CMake documentation for detailed help. The install step is mandatory if you want to correctly setup translations and some other stuff. If the build procedure successfully finished, the folder _dist should now contain the application binary and data files.

License

Please see the file LICENSE.txt for details.

Authors

Please see the file AUTHORS.txt for details.

Notes

This file is written in reStructuredText and can be converted to HTML with Python docutils. Use the following command:

$ rst2html README.rst > README.html