Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/festim-dev/pathview

PathView: A Graphical User Interface for System Simulation

https://github.com/festim-dev/pathview

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary
Last synced: 8 months ago · JSON representation

Repository

PathView: A Graphical User Interface for System Simulation

Basic Info
Statistics
  • Stars: 11
  • Watchers: 1
  • Forks: 0
  • Open Issues: 29
  • Releases: 1
Created 12 months ago · Last pushed 9 months ago
Metadata Files
Readme Contributing License Code of conduct Support Roadmap

README.md

PathView

An interactive visual tool built with React Flow and a python (Flask) backend for system modelling using PathSim.

Required Installations

Make sure the following are installed on your system: - Node.js + npm - Python 3.8+ - pip for Python package management

Project Structure

```bash pathview/

├── package.json # Frontend (React) dependencies

├── requirements.txt # Backend dependencies

├── src/

│ ├── backend.py # Python backend API

│ ├── components/ # JSx components

│ ├── python/ # python package source

│ ├── main.jsx

│ ├── App.jsx # main App

│ ├── nodeConfig.js # file to configure all the nodes

```

Installation and Setup

Once in the directory, install frontend and backend dependencies:

Front end bash npm install Back end

Recommend setting up a virtual environment. Proceed as follows: ```bash cd src python -m venv venv source venv/bin/activate # macOS/Linux venv\Scripts\activate # Windows

pip install -r requirements.txt # install the web app requirements (eg. Flask) pip install -e .[dev] # install the python module containing pathsim utils ```

Running Application

You can run both frontend and backend at once npm run start:both This will: - Start the React frontend at http://localhost:5173 - Start the Flask backend at http://localhost:8000

If you are working on one side, you can also run the following commands for front end and back end respectively: npm run dev npm run start:backend

Building the documentation

The project uses Sphinx to generate documentation from the reStructuredText files in the docs/ directory.

Prerequisites

Make sure you have Sphinx installed: bash pip install sphinx sphinx-book-theme

Building HTML Documentation

To build the HTML documentation: bash cd docs make html

The generated documentation will be available in docs/_build/html/index.html.

Viewing the Documentation

After building, you can view the documentation by opening docs/_build/html/index.html in your web browser, or serve it locally: ```bash

From the docs/_build/html directory

python -m http.server 8080 ``` Then visit http://localhost:8080 in your browser.

Owner

  • Name: festim-dev
  • Login: festim-dev
  • Kind: organization

GitHub Events

Total
  • Create event: 7
  • Issues event: 10
  • Release event: 1
  • Watch event: 5
  • Delete event: 7
  • Member event: 1
  • Issue comment event: 5
  • Public event: 1
  • Push event: 24
  • Pull request review comment event: 2
  • Pull request review event: 3
  • Pull request event: 14
Last Year
  • Create event: 7
  • Issues event: 10
  • Release event: 1
  • Watch event: 5
  • Delete event: 7
  • Member event: 1
  • Issue comment event: 5
  • Public event: 1
  • Push event: 24
  • Pull request review comment event: 2
  • Pull request review event: 3
  • Pull request event: 14

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 7
  • Total pull requests: 8
  • Average time to close issues: 11 days
  • Average time to close pull requests: about 5 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.29
  • Average comments per pull request: 0.25
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 8
  • Average time to close issues: 11 days
  • Average time to close pull requests: about 5 hours
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.29
  • Average comments per pull request: 0.25
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • RemDelaporteMathurin (7)
Pull Request Authors
  • RemDelaporteMathurin (6)
  • tasnimxvi (2)
Top Labels
Issue Labels
functionality (2) frontend (2) backend (1)
Pull Request Labels
functionality (1) frontend (1)

Dependencies

package-lock.json npm
  • 217 dependencies
package.json npm
  • @eslint/js ^9.25.0 development
  • @types/react ^19.1.2 development
  • @types/react-dom ^19.1.2 development
  • @vitejs/plugin-react ^4.4.1 development
  • concurrently ^9.2.0 development
  • eslint ^9.25.0 development
  • eslint-plugin-react-hooks ^5.2.0 development
  • eslint-plugin-react-refresh ^0.4.19 development
  • globals ^16.0.0 development
  • vite ^6.3.5 development
  • react ^19.1.0
  • react-dom ^19.1.0
.github/workflows/build-deploy-docs.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/upload-pages-artifact v3 composite
.github/workflows/ci.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
  • actions/setup-python v4 composite
Dockerfile docker
  • node 18-alpine build
  • python 3.11-slim build
pyproject.toml pypi
  • matplotlib >=3.7.0
  • numpy >=1.24.0
  • pathsim >=0.8.2
  • plotly >=6.0
requirements.txt pypi
  • Flask >=3.1.1
  • docutils >=0.17.0
  • flask-cors >=6.0.1
  • sphinx >=4.0.0