ramp-stream 1.1.2__tar.gz

ramp_stream-1.1.2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run '...'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System configuration (please complete the following information):**
+ - OS: [e.g. Ubuntu]
+ - Package Version [e.g. 0.0.0]
+
+**Additional context**
+Add any other context about the problem here.

ramp_stream-1.1.2/.github/ISSUE_TEMPLATE/documentation-improvement.md

@@ -0,0 +1,20 @@
+---
+name: Documentation Improvement
+about: Proposed changes to the documentation
+title: "[Doc]"
+labels: documentation
+assignees: ''
+
+---
+
+# Is anything incorrect?
+Usually, when a change is proposed to the documentation it is because we forgot to update it, and documentation rot took hold.
+Please let us know what you found to be incorrect, if applicable.
+
+# Is anything missing?
+Sometimes, you want an explanation for a particular piece of code, or an example for how to use something, that is simply not there.
+Please let us know what you'd like to see, and we can try to write it!
+
+# Can something be improved?
+It isn't very often that someone takes the time to help us improve our documentation when something is there and presented correctly, but could be better.
+Thank you for taking the time to let us know! Please give us a suggestion for what we could improve next, or even better, open a pull request with your changes! We'd love for you to help out with either of these methods.

ramp_stream-1.1.2/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feature]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want things to look like.
+
+**Describe proposed solutions you've considered**
+A clear and concise description of proposed solutions you considered.
+If you can argue for and against them so we can pick the best one, please do.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

ramp_stream-1.1.2/.github/pull_request_template.md

@@ -0,0 +1,26 @@
+# Description
+Describe the purpose of this pull request.
+What is the problem that we're trying to fix, and what is the solution about.
+
+For example:
+> There is a bug where deserializing a Calculation creates a new entity separate from the original serialized object. This pull request fixes that.
+
+If this discussion already appears on an issue that this pull request is meant to solve, that's even better! In that case, a short sentence such as the following suffices:
+> This pull request solves issue #5 as decided in that discussion. See the discussion therein.
+
+# Tests
+Please describe tests that you added or changed to ensure that things behave correctly. This will ensure that we don't regress on this issue in the future.
+
+For example:
+> I added a test called `test_serialize_deserialize` that takes a specific `Calculation`, serializes and deserializes it with `pickle`, and ensures the result is the same object with an `is` assertion.
+
+# Additional information
+If there is some important detail about your changes that you think the reviewer should know about, please list it here.
+
+# Checklist before your pull request is ready
+- [ ] I tested the code locally, and it passes without new warnings that weren't there before
+- [ ] I reviewed my own code
+- [ ] My new code is documented and the documentation to code that I changed code is still applicable
+- [ ] Any changes I made to public API that may break downstream packages was accepted by the community in the discussion in the Issue Tracker
+
+Please do these things yourself before you post this pull request to save you and others some time.

ramp_stream-1.1.2/.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Build and Deploy Sphinx Docs
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Setup micromamba
+      uses: mamba-org/setup-micromamba@v2.0.6
+      with:
+        environment-file: docs/requirements.yml
+        environment-name: stream-${{ github.run_id }}-${{ github.run_attempt }}
+        post-cleanup: 'all'
+
+    - name: Install local
+      run: |
+        pip install -e .
+      shell: micromamba-shell {0}
+    
+    - name: Build Sphinx documentation
+      run: |
+        cd docs
+        make html
+        cd ../
+      shell: micromamba-shell {0}
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/build/html
+
+  deploy:
+    needs: build-docs
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
+

ramp_stream-1.1.2/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "dev" ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Ruff check
+      uses: astral-sh/ruff-action@v3
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: setup-micromamba
+      uses: mamba-org/setup-micromamba@v2.0.6
+      with:
+        environment-file: allreq.yml
+        environment-name: stream-${{ github.run_id }}-${{ github.run_attempt }}
+        post-cleanup: 'all'
+    - name: Install local
+      run: |
+        pip install .
+      shell: micromamba-shell {0}
+    - name: Test doctests
+      run: |
+        pytest -v --doctest-modules stream
+      shell: micromamba-shell {0}
+    - name: Test with pytest
+      run: |
+        cd tests
+        pytest -v -m "not graphs"
+      shell: micromamba-shell {0}

ramp_stream-1.1.2/.gitignore

@@ -0,0 +1,20 @@
+.cache
+.idea
+__pycache__
+*.pyc
+.ipynb_checkpoints
+.hypothesis
+*.egg-info
+/docs/build/
+build
+/.pytest_cache/
+*.swp
+*regression*
+CLAUDE.md
+.vscode/
+dist/
+.coverage
+coverage.xml
+htmlcov/
+.env
+*.log

ramp_stream-1.1.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,109 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of any personal characteristics or identity.
+We pledge to treat everyone with civility, to act and interact in ways that contribute to an open, 
+welcoming and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+nuclear.ramp.dev@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders should consult these enforcement methods for any action they 
+deem in violation of this Code of Conduct:
+
+### 1. Correction
+A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+A privately written warning with explicit consequences for continued behavior.
+The warning should include the information as in a Correction, but also include
+a demand that the offending party will avoid interaction with the affected party
+for a specified period of time. This includes interaction in community events,
+on this project or outside these spaces such as on social media.
+Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+This step should only be taken if a warning was previously given to the 
+offending party or for more serious violations that require a public and immediate 
+action.
+
+### 4. Permanent Ban
+A permanent ban from any sort of public interaction within the community.
+A permanent ban should only result from continued violations or a pattern
+of behavior that is incompatible with this Code of Conduct.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

ramp_stream-1.1.2/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing
+
+Thank you for considering a contribution to our project. 
+We welcome new members to the community and this guide is meant to help you make your 
+first steps with our community.
+
+## Code of Conduct
+
+Participants in the this project are expected to follow and uphold the [Code
+of Conduct](CODE_OF_CONDUCT.md). 
+Please report any unacceptable behavior to the email described therein.
+
+## How to report bugs
+We have a template for bugs in our issue tracker. 
+All bugs are tracked through the issue tracker, so please use that!
+
+## How to ask for improvements or new features
+
+We welcome constant improvement, and we have a template for new features in our issues tracker.
+You should notice that our team is small, and it may take some time for us to deal with any
+specific request, or we may find that the request creates too heavy a burden for us to maintain.
+If you are interested in contributing yourself, please say so in your issue. It is much easier
+for us to accept new features when the community is willing to work alongside the core team on them.
+
+## How to submit changes
+
+All changes to the `dev` and `main` branches happen through pull requests.
+Feature branches should target the `dev` branch for their pull request, where the code will be reviewed
+and any appropriate checks will run.
+The code will be reviewed by the community, and such a review should ensure that the committed code is
+correct as well as that its quality meets our standards.
+The reviewers may ask you for some changes before they are willing to merge your changes in, or they
+may change some things themselves in a collaborative effort. Please remember that while your contribution
+is welcome, it is always part of a group effort, and the group has the right to edit or even reject parts
+of your contribution to meet the community's needs.
+Such changes, suggestions and requests should always follow the Code of Conduct, as well as your own
+contribution. Please report any unacceptable behavior during the review process if you encounter it.
+
+## Code Style
+
+We currently don't have a written-down style guide, and we should get around to it.
+This may cause some friction, since style is a matter of preference, but if both you and your reviewers
+apply a positive mindset that we're all trying to get the project to be at its best, we will likely
+find a suitable solution.
+
+If you find that much of your time is taken on discussions about a style guide that isn't there,
+please let us know and we'll make this a higher priority.

ramp_stream-1.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aviv Barnea
+
+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.

ramp_stream-1.1.2/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: ramp-stream
+Version: 1.1.2
+Summary: System-level Thermohydraulics Code for reactor analysis using modular DAE coupling of components
+Author-email: Nuclear RAMP team <nuclear.ramp.dev@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cachetools
+Requires-Dist: cytoolz
+Requires-Dist: ipython
+Requires-Dist: matplotlib
+Requires-Dist: more-itertools
+Requires-Dist: networkx
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: rich
+Requires-Dist: scikits.odes
+Requires-Dist: scipy
+Requires-Dist: dask
+Requires-Dist: pyyaml
+Provides-Extra: test
+Requires-Dist: cloudpickle; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-regressions; extra == "test"
+Requires-Dist: graphviz; extra == "test"
+Dynamic: license-file
+
+# **S**ystem **T**hermohydraulics for **R**eactor **E**valuation, **A**nalysis & **M**odeling
+
+In a sentence: ***STREAM is a versatile, easily extensible, modern nuclear reactor system code***. 
+
+A `System Code` is a tool enabling the simulation of nuclear reactor heat evacuation during normal operation and postulated accidents, 
+which is done approximately without employing very expensive higher fidelity tools as CFD (computational fluid dynamics) codes and neutron transport.
+
+In a few more words, STREAM is:
+#### 1. A general purpose graph-based solver for large systems of coupled differential and algebraic equations:
+```math
+M\frac{d\vec{y}}{dt} = \vec{F}(\vec{y}, t)
+```
+This equation is described by designating subsections as separate (coupled but independent) calculations. 
+Those calucaltions are viewed as nodes in a directed graph whose edges are the coupled variables.
+
+#### 2. A library of thermal-hydraulic components and correlations
+STREAM supports the following capabilities:
+
+* Single phase, one dimensional coolant channels.
+* Point Neutronics and decay heat computation.
+* Reactor Protection System events and triggers.
+* Support for a general incompressible flow graph through Kirchhoff's Laws:
+```math
+\sum_{\text{loop}}\Delta p = 0; \sum_{\text{junction}}\dot{m}=0
+```
+* Cartesian and cylindrical heat structures with 2D heat diffusion.
+* Subcooled Boiling heat transfer support.
+* Flow regime support (**turbulent, laminar, and free convection**)
+* Many other thermohydraulic components: Ideal pump, heat exchanger, friction and local regime dependent pressure drops, flapper
+* Uncertainty Quantification through Uncertainty Propagation (which can be computed in a distributed fashion through DASK)

ramp_stream-1.1.2/README.md

@@ -0,0 +1,30 @@
+# **S**ystem **T**hermohydraulics for **R**eactor **E**valuation, **A**nalysis & **M**odeling
+
+In a sentence: ***STREAM is a versatile, easily extensible, modern nuclear reactor system code***. 
+
+A `System Code` is a tool enabling the simulation of nuclear reactor heat evacuation during normal operation and postulated accidents, 
+which is done approximately without employing very expensive higher fidelity tools as CFD (computational fluid dynamics) codes and neutron transport.
+
+In a few more words, STREAM is:
+#### 1. A general purpose graph-based solver for large systems of coupled differential and algebraic equations:
+```math
+M\frac{d\vec{y}}{dt} = \vec{F}(\vec{y}, t)
+```
+This equation is described by designating subsections as separate (coupled but independent) calculations. 
+Those calucaltions are viewed as nodes in a directed graph whose edges are the coupled variables.
+
+#### 2. A library of thermal-hydraulic components and correlations
+STREAM supports the following capabilities:
+
+* Single phase, one dimensional coolant channels.
+* Point Neutronics and decay heat computation.
+* Reactor Protection System events and triggers.
+* Support for a general incompressible flow graph through Kirchhoff's Laws:
+```math
+\sum_{\text{loop}}\Delta p = 0; \sum_{\text{junction}}\dot{m}=0
+```
+* Cartesian and cylindrical heat structures with 2D heat diffusion.
+* Subcooled Boiling heat transfer support.
+* Flow regime support (**turbulent, laminar, and free convection**)
+* Many other thermohydraulic components: Ideal pump, heat exchanger, friction and local regime dependent pressure drops, flapper
+* Uncertainty Quantification through Uncertainty Propagation (which can be computed in a distributed fashion through DASK)

ramp_stream-1.1.2/allreq.yml

@@ -0,0 +1,22 @@
+dependencies:
+  - cachetools
+  - cytoolz
+  - ipython
+  - matplotlib
+  - more-itertools
+  - networkx
+  - numba
+  - numpy
+  - pandas
+  - python
+  - rich
+  - scikits.odes
+  - scipy
+  - sundials
+  - dask
+  - yaml
+  - pytest
+  - hypothesis
+  - cloudpickle
+  - pytest-regressions
+  - python-graphviz

ramp_stream-1.1.2/docs/.gitignore

@@ -0,0 +1 @@
+source/_static/mathjax

ramp_stream-1.1.2/docs/Makefile

@@ -0,0 +1,27 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+MATHJAX       = lib/mathjax
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile clean
+
+clean:
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo "Removing mathjax static library..."
+	@rm -fr $(SOURCEDIR)/_static/mathjax
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@cp -r $(CONDA_PREFIX)/$(MATHJAX) $(SOURCEDIR)/_static/
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ramp_stream-1.1.2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

ramp_stream-1.1.2/docs/requirements.yml

@@ -0,0 +1,27 @@
+dependencies:
+  - cachetools
+  - cytoolz
+  - graphviz
+  - ipython
+  - matplotlib
+  - more-itertools
+  - numba
+  - numpy
+  - pandas
+  - python
+  - rich
+  - scikits.odes
+  - scipy
+  - sundials
+  - dask
+  - yaml
+  - jupyter
+  - mathjax
+  - matplotlib
+  - nbsphinx
+  - networkx
+  - numpydoc
+  - sphinx
+  - sphinx_rtd_theme
+  - hypothesis
+  - pytest

ramp_stream-1.1.2/docs/source/Contributing.rst

@@ -0,0 +1,17 @@
+Contributing
+============
+**Your contribution is welcome!**
+The best way to contribute is through the Issues section on our page.
+Otherwise, there are several places throughout the code where :ref:`TODOS` are still present,
+which may be easier to tackle, presented below. If you feel this is a bit much, starting with
+reading, proofing and improving the :ref:`Documentation` might be easier, and it will be much appreciated.
+
+TODOS
+-----
+.. todolist::
+
+
+
+Style Guide
+-----------
+We try to adhere to :pep:`8` as much as possible.