ramp-coreoperator 0.0.2__tar.gz

ramp_coreoperator-0.0.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_coreoperator-0.0.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_coreoperator-0.0.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_coreoperator-0.0.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 an Isotope creates a new entity separate from the original serialized object. This pull request fixes that, so the singleton behavior is maintained in this case.
+
+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 Isotope, 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_coreoperator-0.0.2/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+# 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
+    - uses: actions/setup-python@v6
+      with:
+        python-version: '3.14' 
+    - name: Install this package
+      run: |
+        pip install .
+    - name: Run and import
+      run: |
+        python3 -c "from coreoperator import OperationalState"
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v6
+      with:
+        python-version: '3.14' 
+    - name: Install this package
+      run: |
+        pip install .[test]
+    - name: Test in test directory
+      run: |
+        cd tests
+        pytest -v

ramp_coreoperator-0.0.2/.gitignore

@@ -0,0 +1,8 @@
+.hypothesis
+.idea
+build
+docs/build
+docs/source/_static
+*.egg-info
+__pycache__
+.pytest_cache

ramp_coreoperator-0.0.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_coreoperator-0.0.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_coreoperator-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eshed Magali
+
+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_coreoperator-0.0.2/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: ramp-coreoperator
+Version: 0.0.2
+Summary: Package for applying operations on cores from coremaker
+Author-email: Nuclear RAMP team <nuclear.ramp.dev@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Eshed Magali
+        
+        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.
+        
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+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
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: more-itertools
+Requires-Dist: numpy
+Requires-Dist: ramp-coremaker
+Requires-Dist: ramp-core
+Requires-Dist: ramp-isotopes
+Provides-Extra: test
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: pandas; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+Package for changing core states, used for things like mobilizations and density updates.

ramp_coreoperator-0.0.2/README.md

@@ -0,0 +1 @@
+Package for changing core states, used for things like mobilizations and density updates.

ramp_coreoperator-0.0.2/coreoperator/__init__.py

@@ -0,0 +1,14 @@
+"""
+Package for defining operations on core states and for maintaining an
+operational history for it.
+"""
+
+from .featherstate import FeatherState
+from .history import History, OperationalPeriod, StateParams
+from .mobilization import jsonable as mob_jsonable
+from .operational_state import OperationalState
+
+jsonable = mob_jsonable + [History, OperationalState, FeatherState, OperationalPeriod, StateParams]
+
+__all__ = ["jsonable", "OperationalState", "FeatherState", "History", "StateParams"]
+

ramp_coreoperator-0.0.2/coreoperator/example.py

@@ -0,0 +1,11 @@
+from coremaker.example import example_core
+
+from coreoperator.history import History, StateParams
+from coreoperator.operational_state import OperationalState
+
+blank_hist = History()
+example_state = OperationalState(history=blank_hist,
+                                 params=StateParams(power=0),
+                                 tags={"blank"},
+                                 core=example_core,
+                                 )

ramp_coreoperator-0.0.2/coreoperator/featherstate.py

@@ -0,0 +1,89 @@
+import pickle
+import zlib
+from typing import Any, Literal, Type, TypeVar
+
+try:
+    from typing import Self
+except ImportError:
+    Self = TypeVar("Self")
+
+from coremaker.core import Core
+
+from .operational_state import OperationalState
+
+Zlib_Compression = Literal[-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+DEFAULT_COMPRESSION = 2 # A sensible default, fast and still has an effect for us
+
+
+class FeatherState(OperationalState):
+    """An OperationalState that takes less space in memory and is much easier to
+    transmit over the wire.
+
+    This comes at the cost of slightly less comfortable ergonomics, because one
+    cannot directly edit `state.core` and has to explicitly reset the core with
+    a setter method to make changes stick.
+    To make the ergonomics similar, we made OperationalState similarly complex,
+    but deem the tradeoff to be worth the trouble.
+
+    """
+
+    ser_identifier = "FeatherState"
+    __zcore: bytes
+
+    def __init__(self, *, compression_level: Zlib_Compression = DEFAULT_COMPRESSION, **kw):
+        """
+        
+        Parameters
+        ----------
+        compression_level: Zlib_Compression
+            The compression level to use. See the `zlib` standard library documentation for details.
+            Defaults to a fast compression that still has a significant impact. Subject to change.
+        kw:
+            Keywords used to make an OperationalState. See that class for details.
+
+        """
+        self.compression_level = compression_level
+        super().__init__(**kw)
+
+    def serialize(self) -> tuple[str, dict[str, Any]]:
+        parent_serialized_data = super().serialize()[1]
+        parent_serialized_data["compression"] = self.compression_level
+        return self.ser_identifier, parent_serialized_data
+
+    @classmethod
+    def deserialize(cls: Type[Self], d: dict[str, Any], *args, **kwargs) -> Self:
+        compression = d.pop("compression")
+        return cls.from_state(super().deserialize(d=d, *args, **kwargs), compression_level=compression)
+
+    @classmethod
+    def from_state(cls: Type[Self], 
+                   state: OperationalState,
+                   compression_level: Zlib_Compression = DEFAULT_COMPRESSION,
+                   ) -> Self:
+        """Creates a FeatherState from an OperationalState
+
+        Parameters
+        ----------
+        state: OperationalState
+            The OperationalState to compress
+        compression_level: Zlib_Compression
+            The compression level to use. See the `zlib` standard library documentation for details.
+
+        """
+        if isinstance(state, FeatherState):
+            state.compression_level = compression_level
+            return state
+        return cls(**state.as_dict(), compression_level=compression_level)
+
+    @property
+    def core(self) -> Core:
+        return pickle.loads(zlib.decompress(self.__zcore))
+
+    @core.setter
+    def core(self, core):
+        self.__zcore = zlib.compress(pickle.dumps(core), self.compression_level)
+
+    @property
+    def _core(self) -> Core:
+        return self.core
+