Skip to content

chrisjl154/GraphZoom

Repository files navigation

This code sucks. Don't judge me, I was a fresher.

GraphZoom

Installation

Dependencies

To install the software, ensure the following dependencies are installed:
  • Flask 1.0 or greater
  • Python 3.3 or greater
  • Numpy 1.14.3 or greater
  • NetworkX 2.1 or greater

All dependencies required for the UI (JQuery, CytoScape and so forth are included already. do not alter these versions)

To run the UI use an updated, modern browser such as Chrome.

Installing the program

Because the program consists of scripts mainly, there is no need to directly install anything. Simply download the provided zip folder, extract it to a desired location and run the script defined for your OS (run.bat for Windows, run.sh for Linux and Mac)

Usage

Use the run script to start the program. This starts the Flask server, opens the UI, and initiates all of the code needed to start the program. If you run the script but your browser does not automatically open the webpage/UI simply browse to 127.0.0.1:5000 in your browser.

Development and maintenance

The UI

The UI has been written with HTML, CSS and JS. All of the related files for the UI are in the static and templates folders. Cytoscape is used for drawing, manipulating and rendering the graph. Most of the code needed for rendering and interacting with the graph itself is included in main.js. Code relating to interacting with the back-end of the software is included in BackConnect.js.

Not yet Finished