DaViz - Distributed Algorithms Visualization

This forked repostory is not maintaned since 2020. Feel free to fork it and make updates. Check the root repository at praalhans/DaViz for a mainted version of DaViz

DaViz is a software tool written in the Haskell and Java programming languages for simulating and visualizing executions of distributed algorithms.

Getting Started

The steps below explain how to setup and run DaViz. For a detailed description of the software, refer to the documentation directory.

Prerequisites

• Java OpenJDK 1.8
• Frege v3.25.42+ (available in lib directory)
• IntelliJ IDEA (Community version is enough)

Setup

1. Clone the repository using git clone git@github.com:praalhans/DaViz.git
2. Open the project in IntelliJ IDEA

There might be the need to download the Jetbrains metadata annotations. To do so, follow the instructions on Add org.jetbrains.annotations to other projects. Currently, the project uses version 18.0.0 for the annotation package.

Windows only

To use the provided scripts, you might need to add the .SH extension to the variable path PATHEXT.

Build and Execution

The dependencies between modules are already configured and shared in the repository.

Base build and application (run) configurations are already available in the project and can be simply executed to build or start the application. The following configurations are available:

• Build Frege source: Generate intermediate Java files for frege implementation in the SimulationFrege module. Available for Zsh and PowerShell (Not tested).
• Run DaViz: Invoke the IDE build/run for the main executable class of the project. Available for Frege and Java ports.
• Run DaViz and build Frege source: Run all combinations of the two configurations above.

These configurations were verified to work for Mac OS and Linux distributions. They were not tested yet on Windows.

Currently, Frege source is build by running the frege-build script. The core files that contains dependencies are defined in FREGE_CORE_SOURCES_TO_COMPILE in the correct compilation order. After this, a second compilation is performed in all Frege sources. These files are compiled using the Frege JAR located in the lib directory and generate java and class files in the src directory, to remove the unknown references errors displayed in the IDE. Once all files are compiled, the class files are removed. If new Frege files are created, they need to be added in the script.

Although this workflow overhead is minimal since the project is small, we know that this solution is not optimal, thus better alternatives are welcome. Considered alternatives to this process could be:

• Using the IntelliJ Frege compiler plugin or Maven dependency → Not recommended as both are outdated and likely unstable.
• Enhancing the script to be more automated and require less manual changes
• Verify the possibility of using proper build tools, such as Gulp or Maven

Generating Executable JAR

Configurations to generating executable JARs are also provided. To run these configurations, go to Build > Build artefacts and select the desired configuration. Currently, there are 2 configurations: a Java native solution and a Java-Haskell/Frege solution. The resulting build will be located at out/artefacts.

For additional configurations, refers to the Package your application in a JAR docs.

Haskell

For learning Haskell, refer to:

• Haskell Tutorial by Derek Banas - YouTube Video - Great introduction to Haskell.
• Learn You a Haskell by Miran Lipovača - Free online or paid printable Book - Great coverage fo Haskell, from basics to advanced scenarios.
• Haskell Documentation
• The Haskell Cheatsheet by Justin Bailey
• Introduction to Functional Programming - FreeEdx course to learn functional programming focused on Haskell.

Modules

This project is organized using the Modules structure from IntelliJ IDEA. Currently, there is 1 UI module (Swing), 4 simulation modules (Core, Java, Frege and Dummy) and 2 port modules (Java and Frege). While there is just one UI module, it is possible to run DaViz as a native Java solution using the Java module or as a Java-Haskell solution using the Frege module. The Core module provides shared classes between the Java and Frege modules. The Dummy module serves to inform the UI module the existent classes and methods, but it will be overridden by the dependency load in the Port module. The Port modules wrap the dependencies required for the given port.

Port modules:

• DaVizJava
• DaVizFrege

UI modules:

• Swing

Simulation modules:

• Core
• Frege
• Java (Not ready for use)
• Dummy

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Changelog

See the CHANGELOG to learn about the latest improvements.

Authors

• Hans-Dieter Hiep - praalhans - hdh@cwi.nl - Centrum Wiskunde & Informatica
• Wesley Shann - sshann - w.genizshann@student.vu.nl - Vrije Universiteit, Amsterdam

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• prof. dr. Wan J. Fokkink