Merge pull request #82 from OCNS/graph

🌆 Sunsetting our fly.dev deployment

Author: mstimberg

.github/workflows/deploy.yml

@@ -20,3 +20,10 @@ jobs:
       run: python tests/validate_data.py
     - name: Parsing YAML files (checking for correct relations)
       run: python src/data.py
+    - name: Verify URLs
+      uses: urlstechie/urlchecker-action@0.0.34
+      with:
+          subfolder: simtools
+          file_types: .yaml
+          retry_count: 3
+          force_pass: false

.github/workflows/test.yml

@@ -14,8 +14,8 @@ jobs:
     - uses: actions/setup-python@v5
       with:
           python-version: '3.11'
-    - name: install yaml
-      run: python -m pip install pyyaml
+    - name: install dependencies
+      run: python -m pip install -r requirements.txt
     - name: update json file
       run: python yaml2json.py
     - name: commit if necessary

.github/workflows/update_json.yml

@@ -18,8 +18,3 @@ Now, the pre-commit checks will be run before each commit.
 
 Data on each tool is included in individual files in the `simselect` directory.
 To make changes, please fork the repository, make any necessary changes, and open pull requests for community review.
-
-### Deployment
-The web app is hosted on [fly.io](https://fly.io/). It gets deployed automatically
-via a [GitHub Action](.github/workflows/deploy.yml). When a pull request is merged into ``main``, it will be deployed
-to https://simselect-dev.fly.dev. A tagged release will be deployed to https://simselect.fly.dev.

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 - present, iVis@Bilkent.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.MIT

@@ -11,25 +11,30 @@ simulator. See OCNS/SoftwareWG#117 For more details, and announcements of the re
 meetings.
 
 ## Development notes
-A fresh virtual environment is suggested for development:
+The website is built with ["vanilla JS"](http://vanilla-js.com/) and uses the [cytoscape.js](https://js.cytoscape.org/)
+library for graph visualisation. The full code runs in the browser, but in order to make it able to access the data, it
+needs to run in a local webserver. You can either use such a webserver as provided by your IDE (e.g. the
+[Live Server extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)) for VS Code,
+or use Python's built-in webserver:
+```
+python -m http.server
+```
+
+Python is also used to pre-process and validate the data when simulator descriptions are changed in one of the YAML files.
+
+If you want to work on that part, we suggest a virtual environment for development:
 ```
 python -m venv .venv
 source .venv/bin/activate
 ```
 One can also use `conda` and other tools to set up virtual environments.
 
-This project is an app built using [Holoviz Panel](https://panel.holoviz.org/).
-You can install it using
+To install the dependencies, you can use:
 ```
 python -m pip install -r requirements.txt
 ```
-To run the app, use:
-```
-panel serve --show src/project_browser.py --static-dirs assets=./assets
-```
-This will open a browser window with the app.
-Firefox/Chrome based browsers are supported.
-Please file an issue if the app does not work with your browser.
+
+
 
 ### Contribution notes
 Please install the necessary linters/pre-commit hooks using the `requirements-dev.txt` file:
@@ -47,9 +52,11 @@ pre-commit install
 Now, the pre-commit checks will be run before each commit.
 
 ## Deployment
-The web app is hosted on [fly.io](https://fly.io/). See https://simselect.fly.dev/ for the latest released (tagged) version, and
-https://simselect-dev.fly.dev for the latest version directly built from the ``main`` branch.
+The website is hosted on https://ocns.github.io/simselect
 
+## Dependencies
+The layout is using the fCoSE algorithm by the [i-Vis Research Lab at Bilkent University](http://www.cs.bilkent.edu.tr/~ivis/).
+The files in the `assets/js` directory are minified versions of the original files, licensed under the [MIT license](LICENSE.MIT).
 
 ## Contributors