add: replicability requirements

kausko · kausko · commit 77077fc4afe1 · 2024-08-05T15:09:33.000-04:00
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "_lib"]
+	path = _lib
+	url = https://github.com/ProvenanceWidgets/ProvenanceWidgets.git
diff --git a/INSTRUCTIONS.txt b/INSTRUCTIONS.txt
@@ -0,0 +1,16 @@
+Script/Instructions for downloading the required dependencies and compiling the code:
+
+1. Open a terminal on your machine and navigate to this project's top-level directory (i.e. where this file is).
+2. Download and install node and npm by following the instructions from https://nodejs.org/en/download/. As noted in `package.json` > "engines", ProvenanceWidgets supports node 20.x LTS or newer and npm 10.x or newer. If you already have an incompatible version of node/npm, use a node version manager (e.g. https://github.com/nvm-sh/nvm or https://github.com/jasongin/nvs) to switch to a supported version.
+3. Install the compatible angular version using `npm install -g @angular/cli@15.2.9`
+4. Install the required dependencies from package.json using `npm install`.
+5. (Optional) - Build a production version of the project in the `/dist` folder using `npm run build`. This step is not required for running the project.
+
+Script/Instructions for reproducing the results in the paper: Using the same terminal from the previous steps, run `npm run start`. The project should now be accessible on `localhost:4200`, provided the port is available. If not, the terminal will prompt you for making it accessible on the next available port.
+
+The visualizations from the paper can be accessed by visiting the following URLS:
+1. Scented widgets: http://localhost:4200/#/scented-widgets
+2. Phosphor objects: http://localhost:4200/#/phosphor-objects
+3. Dynamic Query Widgets: http://localhost:4200/#/dynamic-query-widgets-homefinder
+4. Widgets to visualization one-way interaction: http://localhost:4200/#/widgets-to-vis-one-way
+5. Visualization to widgets one-way interaction: http://localhost:4200/#/vis-to-widgets-one-way
diff --git a/LIABILITY.txt b/LIABILITY.txt
@@ -0,0 +1 @@
+ProvenanceWidgets is distributed under the MIT License, which permits free and open-source usage, modification, and distribution of the software, provided the license and copyright notice are preserved. We understand that the review process and public advertisement will not infringe upon this license, and hereby grant the Graphics Replicability Stamp Initiative (GRSI) Reproducibility Committee and designated reviewers permission to review the submitted code, and to advertise the review publicly after the stamp is approved.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # ProvenanceWidgets Homepage
-The homepage for ProvenanceWidgets.
+The homepage for ProvenanceWidgets - A JavaScript library of UI Controls for Tracking and Dynamically Overlaying Analytic Provenance. This repository includes demos that showcase the capabilities of ProvenanceWidgets and examples of how the library can be used in various scenarios.
+
+Authors: Arpit Narechania, Kaustubh Odak, Mennatallah El-Assady, and Alex Endert
+
+Operating Systems: Windows 10 or newer, MacOSX 11 or newer, Ubuntu 20.04.1 LTS or newer
 
 ## Setup
 - Open the command line/terminal on your machine and navigate to this project's top-level directory (i.e. where this file is).
@@ -11,6 +15,14 @@ The homepage for ProvenanceWidgets.
 - `npm run start`
 - Open the browser (preferrably Chrome) at [http://localhost:4200](http://localhost:4200).
 
+The visualizations from the paper can be accessed by visiting the following URLS:
+
+1. Scented widgets: http://localhost:4200/#/scented-widgets
+2. Phosphor objects: http://localhost:4200/#/phosphor-objects
+3. Dynamic Query Widgets: http://localhost:4200/#/dynamic-query-widgets-homefinder
+4. Widgets to visualization one-way interaction: http://localhost:4200/#/widgets-to-vis-one-way
+5. Visualization to widgets one-way interaction: http://localhost:4200/#/vis-to-widgets-one-way
+
 ## Test
 - `npm run test`
 
diff --git a/README.txt b/README.txt
@@ -0,0 +1,31 @@
+Title of the submission: ProvenanceWidgets - A JavaScript library of UI Controls for Tracking and Dynamically Overlaying Analytic Provenance
+
+Authors: Arpit Narechania, Kaustubh Odak, Mennatallah El-Assady, and Alex Endert
+
+Operating Systems: Windows 10 or newer, MacOSX 11 or newer, Ubuntu 20.04.1 LTS or newer
+
+All instructions for setting up and running the project are described at the end of this document, and also in `INSTRUCTIONS.txt`.
+
+The source code is linked as a submodule in the `_lib` directory. It is also available at https://github.com/ProvenanceWidgets/ProvenanceWidgets.
+
+The liability form is available in `LIABILITY.txt`.
+
+--- INSTRUCTIONS ---
+
+Script/Instructions for downloading the required dependencies and compiling the code:
+
+1. Open a terminal on your machine and navigate to this project's top-level directory (i.e. where this file is).
+2. Download and install node and npm by following the instructions from https://nodejs.org/en/download/. As noted in `package.json` > "engines", ProvenanceWidgets supports node 20.x LTS or newer and npm 10.x or newer. If you already have an incompatible version of node/npm, use a node version manager (e.g. https://github.com/nvm-sh/nvm or https://github.com/jasongin/nvs) to switch to a supported version.
+3. Install the compatible angular version using `npm install -g @angular/cli@15.2.9`
+4. Install the required dependencies from package.json using `npm install`.
+5. (Optional) - Build a production version of the project in the `/dist` folder using `npm run build`. This step is not required for running the project.
+
+Script/Instructions for reproducing the results in the paper: Using the same terminal from the previous steps, run `npm run start`. The project should now be accessible on `localhost:4200`, provided the port is available. If not, the terminal will prompt you for making it accessible on the next available port.
+
+The visualizations from the paper can be accessed by visiting the following URLS:
+1. Scented widgets: http://localhost:4200/#/scented-widgets
+2. Phosphor objects: http://localhost:4200/#/phosphor-objects
+3. Dynamic Query Widgets: http://localhost:4200/#/dynamic-query-widgets-homefinder
+4. Widgets to visualization one-way interaction: http://localhost:4200/#/widgets-to-vis-one-way
+5. Visualization to widgets one-way interaction: http://localhost:4200/#/vis-to-widgets-one-way
+
diff --git a/_lib b/_lib
@@ -0,0 +1 @@
+Subproject commit 386f605e6e9b6717a9c6baf4f56b89f2f82cd283

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "_lib"]`
	`2`	`+ path = _lib`
	`3`	`+ url = https://github.com/ProvenanceWidgets/ProvenanceWidgets.git`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+ProvenanceWidgets is distributed under the MIT License, which permits free and open-source usage, modification, and distribution of the software, provided the license and copyright notice are preserved. We understand that the review process and public advertisement will not infringe upon this license, and hereby grant the Graphics Replicability Stamp Initiative (GRSI) Reproducibility Committee and designated reviewers permission to review the submitted code, and to advertise the review publicly after the stamp is approved.