Skip to content

Latest commit

 

History

History
73 lines (41 loc) · 1.89 KB

README.md

File metadata and controls

73 lines (41 loc) · 1.89 KB
Raw

SimGraphVisualizer

SimGraphVisualizer is a javascript library for visualising and editing Ising graphs. The library uses the javascript programming language so that it runs in the browser and does not require a powerful server.

It is also possible to compile into a desktop application using the ElectronJS library and the Chromium engine.

License

SimGraphVisualizer is copyright by Dariusz Pojda [email protected] and is distributed under the Apache License 2.0.

Subdirectories

Here are some of the subdirectories and their contents:

  • / holds some important project files, as license.txt, README, etc...

  • /src holds the source files. The .js files are concatenated together to produce public_html/js/sgv.js

  • /public_html holds the html/php files for the example web site.

  • /public_html/js holds the library file sgv.js and optionaly minimized sgv.min.js file.

Clonning repository

git clone https://github.com/euro-hpc-pl/simGraphVisualizer.git

cd simGraphVisualizer

Dependency installation

You should to run the npm install command first to download the missing modules:

npm install

Building

You don't need to rebuild library after load it from repository, because it is compiled before.

If you need to do it, you can rebuild the library with the command:

npm run build

or (if you have gulp installed globally):

gulp build

Using in web browser mode

To use the library in web browser mode, simply copy the contents of the public_html directory anywhere. The index.html file is an example of usage.

Using in desktop mode

Fast running desktop application:

npm run start

Compiling to executable file:

npm run package

Building installer:

npm run make