Listed below are two options to access the application.
- Navigate to https://puddle-os.herokuapp.com
- Follow the "Local Install Guide" below.
- Clone the repository locally.
- Open a terminal as Admin/root.
- Change to the root directory of PuddleOS.
- Assuming Python 3 and
pip
is installed, runpip install -r requirements.txt
. This will install all the necessary libraries. - Now set the Flask environment variable.
- Unix
export FLASK_APP=app
- Windows
C:\path\to\app>set FLASK_APP=app.py
- PowerShell
PS C:\path\to\app> $env:FLASK_APP = "app.py"
- Run
python -m flask run
- The application should now be running under 127.0.0.1:5000
- Settings
- Display - Toggle this to display or hide nodes within the specific layer
- Clustering Method - Select the desired clustering method for the specific layer
- Agglomerative Complete Linkage Hierarchical Clustering
- Graph - Graphical representation of the nodes and Puddles.
- Node Data - This is a dump of the JSON node data.
- Link Data - This is a dump of the JSON link data.
- Log - This is a table with data relating to the last run.
- id - The id of the node.
- target id - The id of the target node.
- px - The previous node x-axis location.
- py - The previous node y-axis location.
- pz - The previous node z-axis location.
- xa - The current node x-axis location.
- ya - The current node y-axis location.
- za - The current node z-axis location.
- xb - The target node x-axis location.
- yb - The target node y-axis location.
- zb - The target node z-axis location.
- dst - The distance from the current node to the target node.
- best dst - The current shortest distance for the current node.
- best dst id - The id of the best dst node.
Please review the "Issues" page for this repo.
Robin Ward - rcw0024@auburn.edu
Matthew Freestone - maf0083@auburn.edu