Skip to content

OCNS/simselect

Repository files navigation

SimSelect

All Contributors

This is a work-in-progress and in pre-alpha state at the moment

This is a project by the OCNS/INCF software working group, aiming to build an easy-to-use tool for finding a suitable computational neuroscience simulator. See OCNS/SoftwareWG#117 For more details, and announcements of the regular meetings.

Development notes

The website is built with "vanilla JS" and uses the cytoscape.js 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) 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.

To install the dependencies, you can use:

python -m pip install -r requirements.txt

Contribution notes

Please install the necessary linters/pre-commit hooks using the requirements-dev.txt file:

python -m pip install -r requirements-dev.txt

To set up pre-commit, please run (only needed once):

pre-commit install

Now, the pre-commit checks will be run before each commit.

Deployment

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. The files in the assets/js directory are minified versions of the original files, licensed under the MIT license.

Contributors

appukuttan-shailesh
appukuttan-shailesh

🚧
Marcel Stimberg
Marcel Stimberg

💻 🚇 🖋 🔣 🚧 🎨 🤔 📆 🔬 👀 ⚠️
Dinara Issagaliyeva
Dinara Issagaliyeva

💻 🎨 🤔 📆 🔬
Eliane Crepaldi Rodrigues
Eliane Crepaldi Rodrigues

🎨 🖋 🔣 🤔 📆 🔬
Brent Huisman
Brent Huisman

💻 🖋 🔣 🚧 🎨 🤔 📆 🔬 👀 ⚠️
Reema Gupta
Reema Gupta

💻 🖋 🔣 🚧 🎨 🤔 📆 🔬 👀 ⚠️
Ankur Sinha
Ankur Sinha

💻 🖋 🔣 🚧 🎨 🤔 📆 🔬 👀 ⚠️
clinssen
clinssen

🖋 🔣