From 017515800e948d6b4558b4bc5c52b4320923757a Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 12 Aug 2025 10:24:13 -0400 Subject: [PATCH 1/3] renamed everything to PathView --- README.md | 2 +- docs/conf.py | 2 +- docs/index.rst | 14 +++++++------- package-lock.json | 6 +++--- package.json | 4 ++-- pyproject.toml | 18 +++++++++--------- src/python/pathsim_utils.py | 2 +- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 535f2621..d461276e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Make sure the following are installed on your system: # Project Structure ```bash -fuel-cycle-sim/ +pathview/ ├── package.json # Frontend (React) dependencies diff --git a/docs/conf.py b/docs/conf.py index 73a42135..cf01d1b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,7 +6,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "fuel-cycle-sim" +project = "pathview" copyright = "2025, Tasnim Zulfiqar, James Dark, Remi Delaporte-Mathurin" author = "Tasnim Zulfiqar, James Dark, Remi Delaporte-Mathurin" diff --git a/docs/index.rst b/docs/index.rst index d3f9bd1f..42d5efc4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,9 @@ -.. fuel-cycle-sim documentation master file, created by +.. pathview documentation master file, created by sphinx-quickstart on Wed Jul 23 14:07:29 2025. -========================================== -Fuel Cycle Simulator (name will change...) -========================================== +======== +PathView +======== An interactive visual tool for modeling and simulating nuclear fuel cycle components using React Flow frontend and Python Flask backend. @@ -67,9 +67,9 @@ Installation Steps 1. **Clone the Repository** .. code-block:: bash - - git clone https://github.com/yourusername/fuel-cycle-sim.git - cd fuel-cycle-sim + + git clone https://github.com/festim-dev/pathview.git + cd pathview 2. **Install Frontend Dependencies** diff --git a/package-lock.json b/package-lock.json index 6b30dd8b..4f188738 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "fuel-cycle-sim", + "name": "pathview", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "fuel-cycle-sim", + "name": "pathview", "version": "0.0.0", "dependencies": { "@codemirror/lang-python": "^6.2.1", @@ -5773,4 +5773,4 @@ } } } -} +} \ No newline at end of file diff --git a/package.json b/package.json index ba91c034..f13d1413 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "fuel-cycle-sim", + "name": "pathview", "private": true, "version": "0.0.0", "type": "module", @@ -33,4 +33,4 @@ "globals": "^16.0.0", "vite": "^6.3.5" } -} +} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index a77c4a76..c6f9450c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,9 +3,9 @@ requires = ["setuptools>=61.0", "wheel", "setuptools-scm[toml] >= 7.0.5"] build-backend = "setuptools.build_meta" [project] -name = "fuel-cycle-sim" +name = "pathview" dynamic = ["version"] -description = "A Python package for fuel cycle simulation with pathsim integration" +description = "A Graphical User Interface for System Simulation" readme = "README.md" license = {file = "LICENSE"} authors = [ @@ -37,17 +37,17 @@ dev = [ [project.urls] -Homepage = "https://github.com/yourusername/fuel-cycle-sim" -Documentation = "https://fuel-cycle-sim.readthedocs.io/" -Repository = "https://github.com/yourusername/fuel-cycle-sim.git" -Issues = "https://github.com/yourusername/fuel-cycle-sim/issues" +Homepage = "https://github.com/festim-dev/pathview" +Documentation = "https://pathview.readthedocs.io/" +Repository = "https://github.com/festim-dev/pathview.git" +Issues = "https://github.com/festim-dev/pathview/issues" [tool.setuptools] -packages = ["fuel_cycle_sim"] -package-dir = {"fuel_cycle_sim" = "src/python"} +packages = ["pathview"] +package-dir = {"pathview" = "src/python"} [tool.setuptools.package-data] -fuel_cycle_sim = ["templates/*"] +pathview = ["templates/*"] [tool.setuptools_scm] write_to = "src/python/_version.py" diff --git a/src/python/pathsim_utils.py b/src/python/pathsim_utils.py index 4804791c..cc56ca51 100644 --- a/src/python/pathsim_utils.py +++ b/src/python/pathsim_utils.py @@ -323,7 +323,7 @@ def get_parameters_for_block_class(block_class, node, eval_namespace): if k == "self": continue # Skip 'operations' for Adder, as it is handled separately - # https://github.com/festim-dev/fuel-cycle-sim/issues/73 + # https://github.com/festim-dev/pathview/issues/73 if k in ["operations"]: continue user_input = node["data"][k] From 0915359721319570175f88a33976129628a3004b Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 12 Aug 2025 10:38:33 -0400 Subject: [PATCH 2/3] replaced elsewhere --- Dockerfile | 2 +- src/App.jsx | 2 +- src/backend.py | 12 ++++++------ src/python/__init__.py | 8 +------- src/python/templates/template_with_macros.py | 2 +- test/test_backend.py | 4 ++-- test/test_convert_python.py | 2 +- test/test_custom_blocks.py | 2 +- test/test_events.py | 2 +- test/test_examples.py | 2 +- 10 files changed, 16 insertions(+), 22 deletions(-) diff --git a/Dockerfile b/Dockerfile index d1f13016..e484fc98 100644 --- a/Dockerfile +++ b/Dockerfile @@ -31,7 +31,7 @@ COPY pyproject.toml . COPY src/ ./src/ # Install python core package with setuptools-scm version override -RUN SETUPTOOLS_SCM_PRETEND_VERSION_FOR_FUEL_CYCLE_SIM=${VERSION} pip install . +RUN SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PATHVIEW=${VERSION} pip install . # Install gunicorn for production WSGI server RUN pip install gunicorn diff --git a/src/App.jsx b/src/App.jsx index 0a489c8b..32654a0f 100644 --- a/src/App.jsx +++ b/src/App.jsx @@ -1176,7 +1176,7 @@ const DnDFlow = () => { onClick={() => { // Display version information and help const pathsimVersion = versionInfo?.pathsim_version || 'Loading...'; - const fcsVersion = versionInfo?.fuel_cycle_sim_version || 'Loading...'; + const fcsVersion = versionInfo?.pathview_version || 'Loading...'; const message = `Help documentation coming soon!\n\n` + `Version Information:\n` + diff --git a/src/backend.py b/src/backend.py index a5aee07d..d9218d6b 100644 --- a/src/backend.py +++ b/src/backend.py @@ -11,8 +11,8 @@ import io from contextlib import redirect_stdout, redirect_stderr -from fuel_cycle_sim.convert_to_python import convert_graph_to_python -from fuel_cycle_sim.pathsim_utils import make_pathsim_model, map_str_to_object +from pathview.convert_to_python import convert_graph_to_python +from pathview.pathsim_utils import make_pathsim_model, map_str_to_object from pathsim.blocks import Scope, Spectrum # Sphinx imports for docstring processing @@ -151,14 +151,14 @@ def get_version(): pathsim_version = getattr(pathsim, "__version__", "Unknown") - import fuel_cycle_sim + import pathview - fcs_version = getattr(fuel_cycle_sim, "__version__", "Unknown") + fcs_version = getattr(pathview, "__version__", "Unknown") return jsonify( { "pathsim_version": pathsim_version, - "fuel_cycle_sim_version": fcs_version, + "pathview_version": fcs_version, "status": "success", } ), 200 @@ -166,7 +166,7 @@ def get_version(): return jsonify( { "pathsim_version": "Unknown", - "fuel_cycle_sim_version": "Unknown", + "pathview_version": "Unknown", "status": "error", "error": str(e), } diff --git a/src/python/__init__.py b/src/python/__init__.py index 540edec7..b902f18e 100644 --- a/src/python/__init__.py +++ b/src/python/__init__.py @@ -1,13 +1,7 @@ -""" -Fuel Cycle Simulation Package - -A Python package for fuel cycle simulation with pathsim integration. -""" - from importlib import metadata try: - __version__ = metadata.version("fuel_cycle_sim") + __version__ = metadata.version("pathview") except Exception: __version__ = "unknown" diff --git a/src/python/templates/template_with_macros.py b/src/python/templates/template_with_macros.py index 35ca8cb0..66225a73 100644 --- a/src/python/templates/template_with_macros.py +++ b/src/python/templates/template_with_macros.py @@ -2,7 +2,7 @@ from pathsim import Simulation, Connection import numpy as np import matplotlib.pyplot as plt -import fuel_cycle_sim +import pathview {# Import macros #} {% from 'block_macros.py' import create_block, create_integrator_block, create_bubbler_block, create_connections, create_event -%} diff --git a/test/test_backend.py b/test/test_backend.py index 0fb79ea8..eb89b31b 100644 --- a/test/test_backend.py +++ b/test/test_backend.py @@ -1,5 +1,5 @@ -from fuel_cycle_sim.pathsim_utils import auto_block_construction, make_connections -from fuel_cycle_sim.custom_pathsim_blocks import ( +from pathview.pathsim_utils import auto_block_construction, make_connections +from pathview.custom_pathsim_blocks import ( Process, Splitter2, Splitter3, diff --git a/test/test_convert_python.py b/test/test_convert_python.py index 116a6891..ee186a2b 100644 --- a/test/test_convert_python.py +++ b/test/test_convert_python.py @@ -1,4 +1,4 @@ -from fuel_cycle_sim import convert_graph_to_python +from pathview import convert_graph_to_python import json import pytest from pathlib import Path diff --git a/test/test_custom_blocks.py b/test/test_custom_blocks.py index dd92ac9d..117ae2db 100644 --- a/test/test_custom_blocks.py +++ b/test/test_custom_blocks.py @@ -1,6 +1,6 @@ import pathsim.blocks from pathsim import Simulation, Connection -from fuel_cycle_sim.custom_pathsim_blocks import Bubbler +from pathview.custom_pathsim_blocks import Bubbler def test_bubbler(): diff --git a/test/test_events.py b/test/test_events.py index ba495208..d2446647 100644 --- a/test/test_events.py +++ b/test/test_events.py @@ -1,5 +1,5 @@ import pytest -from fuel_cycle_sim.pathsim_utils import make_events +from pathview.pathsim_utils import make_events events_data = [ diff --git a/test/test_examples.py b/test/test_examples.py index 028f1daa..87129d00 100644 --- a/test/test_examples.py +++ b/test/test_examples.py @@ -1,4 +1,4 @@ -from fuel_cycle_sim.pathsim_utils import make_pathsim_model +from pathview.pathsim_utils import make_pathsim_model import json import pytest From 6cbe266713a6b97cb369f344fb599493519a3f04 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Tue, 12 Aug 2025 10:44:48 -0400 Subject: [PATCH 3/3] a bit more pathview! --- README.md | 4 ++-- docs/index.rst | 16 ++++++++-------- src/App.jsx | 2 +- src/backend.py | 6 ++---- 4 files changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d461276e..410c3d3f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Fuel Cycle Simulator -An interactive visual tool built with React Flow and a python (Flask) backend to simulate fuel cycle components. +# 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: diff --git a/docs/index.rst b/docs/index.rst index 42d5efc4..eba99b0c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,16 +24,16 @@ An interactive visual tool for modeling and simulating nuclear fuel cycle compon Statement of Need =============================== -Fusion fuel cycle modeling is a critical aspect of nuclear engineering that requires sophisticated tools to analyze material flows, reactor performance, and waste management strategies. The Fuel Cycle Simulator addresses the need for: +System modeling is a critical aspect of nuclear engineering that requires sophisticated tools to analyze material flows, reactor performance, and waste management strategies. PathView addresses the need for: **Accessibility** - Traditional fuel cycle simulation tools are often complex, proprietary, or require extensive training. This tool provides an intuitive visual interface that makes fuel cycle modeling accessible to students, researchers, and professionals. + Traditional system simulation tools are often complex, proprietary, or require extensive training. This tool provides an intuitive visual interface that makes system modeling accessible to students, researchers, and professionals. **Interactivity** - Static models and command-line tools limit exploration and understanding. Our interactive visual approach allows users to build, modify, and experiment with fuel cycle scenarios in real-time. + Static models and command-line tools limit exploration and understanding. Our interactive visual approach allows users to build, modify, and experiment with system scenarios in real-time. **Educational Value** - The visual nature of the tool makes it ideal for teaching fuel cycle concepts, allowing students to see the connections between different components and understand material flows. + The visual nature of the tool makes it ideal for teaching system concepts, allowing students to see the connections between different components and understand material flows. **Research Flexibility** Researchers need tools that can be easily modified and extended. The open-source nature and modular architecture enable customization for specific research needs. @@ -48,7 +48,7 @@ Installation Guide System Requirements ------------------- -Before installing the Fuel Cycle Simulator, ensure your system meets the following requirements: +Before installing PathView, ensure your system meets the following requirements: **Required Software:** - Node.js 18+ and npm @@ -127,7 +127,7 @@ Example Usage Quick Start Example ------------------- -Here's a simple example to get you started with the Fuel Cycle Simulator: +Here's a simple example to get you started with PathView: WIP @@ -159,7 +159,7 @@ WIP Community Guidelines =============================== -Welcome to the Fuel Cycle Simulator community! We're committed to fostering an inclusive, collaborative environment for all contributors. +Welcome to the PathView community! We're committed to fostering an inclusive, collaborative environment for all contributors. Code of Conduct ---------------- @@ -218,7 +218,7 @@ Communication Channels Support =============================== -If you need help with the Fuel Cycle Simulator, here are the best ways to get support: +If you need help with PathView, here are the best ways to get support: - **Documentation**: Start with this documentation - **GitHub Issues**: For bugs and feature requests diff --git a/src/App.jsx b/src/App.jsx index 32654a0f..6eed68e7 100644 --- a/src/App.jsx +++ b/src/App.jsx @@ -1181,7 +1181,7 @@ const DnDFlow = () => { const message = `Help documentation coming soon!\n\n` + `Version Information:\n` + `• PathSim: ${pathsimVersion}\n` + - `• Fuel Cycle Sim: ${fcsVersion}\n\n`; + `• PathView: ${fcsVersion}\n\n`; alert(message); }} diff --git a/src/backend.py b/src/backend.py index d9218d6b..4a9d2097 100644 --- a/src/backend.py +++ b/src/backend.py @@ -131,15 +131,13 @@ def serve_frontend(): if os.getenv("FLASK_ENV") == "production": return app.send_static_file("index.html") else: - return jsonify({"message": "Fuel Cycle Simulator API", "status": "running"}) + return jsonify({"message": "PathView API", "status": "running"}) # Health check endpoint for Cloud Run @app.route("/health", methods=["GET"]) def health_check(): - return jsonify( - {"status": "healthy", "message": "Fuel Cycle Simulator Backend is running"} - ), 200 + return jsonify({"status": "healthy", "message": "PathView Backend is running"}), 200 # Version information endpoint