ramp-core 0.0.4__tar.gz

ramp_core-0.0.4/.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_core-0.0.4/.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_core-0.0.4/.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_core-0.0.4/.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: deployment
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://test.pypi.org/project/ramp-core/
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

ramp_core-0.0.4/.github/workflows/test.yml

@@ -0,0 +1,51 @@
+# 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 ramp_core.serializable import Serializable"
+
+  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: Doctest
+      run: |
+        pytest -v --doctest-modules ramp_core
+    - name: Test in test directory
+      run: |
+        cd tests
+        pytest -v
+

ramp_core-0.0.4/.gitignore

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

ramp_core-0.0.4/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_core-0.0.4/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_core-0.0.4/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_core-0.0.4/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: ramp-core
+Version: 0.0.4
+Summary: Utilities package for the Nuclear RAMP
+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
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cytoolz
+Requires-Dist: numpy
+Provides-Extra: test
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# ramp-core
+Welcome to the core utilities package of the nuclear Reactor Analysis
+Management Project!
+
+## Core utilities of RAMP
+
+This is where we handle serialization, pickling and such things that are used everywhere in the wide project.
+
+This package does almost nothing on its own, and one would usually only
+interact with it as a dependency.
+More often than not, people reading this will find other packages more
+useful, but you're welcome to contribute here too if you came all this
+way :)
+

ramp_core-0.0.4/README.md

@@ -0,0 +1,14 @@
+# ramp-core
+Welcome to the core utilities package of the nuclear Reactor Analysis
+Management Project!
+
+## Core utilities of RAMP
+
+This is where we handle serialization, pickling and such things that are used everywhere in the wide project.
+
+This package does almost nothing on its own, and one would usually only
+interact with it as a dependency.
+More often than not, people reading this will find other packages more
+useful, but you're welcome to contribute here too if you came all this
+way :)
+

ramp_core-0.0.4/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ramp-core"
+authors = [
+    {name = "Nuclear RAMP team", email = "nuclear.ramp.dev@gmail.com"},
+]
+description = "Utilities package for the Nuclear RAMP"
+dynamic = ["version"]
+requires-python = ">=3.11"
+license = {file = "LICENSE"}
+readme = "README.md"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Topic :: Scientific/Engineering",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "cytoolz",
+    "numpy",
+]
+
+[project.optional-dependencies]
+test = [
+    "hypothesis",
+    "pytest",
+]
+
+[tool.setuptools.packages.find]
+include = ['ramp_core*']
+exclude = ['tests*']
+
+[tool.setuptools_scm]

ramp_core-0.0.4/ramp_core/__init__.py

@@ -0,0 +1,2 @@
+from .json import RampJSONDecoder as RampJSONDecoder, RampJSONEncoder as RampJSONEncoder
+from .tempdir import TemporaryDirectory as TemporaryDirectory

ramp_core-0.0.4/ramp_core/json.py

@@ -0,0 +1,111 @@
+"""JSON encoding and decoding tools for RAMP objects"""
+import json
+from typing import Any, Hashable
+
+from ramp_core.serializable import Serializable
+
+IDENTIFIER = 'cls'
+DATA = '__data'
+
+
+class RampJSONEncoder(json.JSONEncoder):
+    """JSONEncoder for ramp objects that can handle Serializable objects.
+
+    It is useful to have a single json-compatible class to handle our long-term serialization of Ramp objects.
+
+    """
+
+    def default(self, obj):
+        try:
+            ident, s = obj.serialize()
+            return s | {IDENTIFIER: ident} if isinstance(s, dict) else {IDENTIFIER: ident, DATA: s}
+        except AttributeError:
+            pass
+        return json.JSONEncoder.default(self, obj)
+
+
+class RampJSONDecoder(json.JSONDecoder):
+    """JSONDecoder for ramp objects that can reconstruct Serializable objects.
+
+    It will be useful to be able to recreate our Python objects for the ramp objects if we serialize them in a
+    long term, non-pickle method.
+
+    The idea is that we save an identifier which allows us to know which Python object to reconstruct.
+    To avoid the Pickle problem, the way we do this is that we assume the decoding user can create a mapping of
+    serialization identifiers to factory classes that have a deserialize method.
+
+    Examples
+    --------
+    >>> class A:
+    ...     ser_identifier = "AA"
+    ...
+    ...     def __init__(self, a):
+    ...         self.a = a
+    ...
+    ...     def serialize(self):
+    ...         return self.ser_identifier, {'a': self.a}
+    ...
+    ...     @classmethod
+    ...     def deserialize(cls, d, **_):
+    ...         return cls(**d)
+    >>>
+    >>> b = A(5)
+    >>> s = json.dumps(b, cls=RampJSONEncoder)
+    >>> try:  # This fails because we didn't set the supported attribute
+    ...     v = json.loads(s, cls=RampJSONDecoder)
+    ... except AttributeError:
+    ...     pass
+    ... else:
+    ...     raise RuntimeError("Should have crashed")
+    >>> RampJSONDecoder.supported = {type(b).ser_identifier: b}
+    >>> v = json.loads(s, cls=RampJSONDecoder)  # And now it succeeds
+    >>> v.a == b.a
+    True
+
+    """
+
+    supported: dict[str, Serializable]
+
+
+    def decode(self, s: str, **kw):
+        pobj = super().decode(s, **kw)
+        if not isinstance(pobj, dict):
+            return pobj
+        if IDENTIFIER not in pobj:
+            return pobj
+        styp = pobj[IDENTIFIER]
+        if styp in self.supported:
+            del pobj[IDENTIFIER]
+            typ = self.supported[styp]
+            if DATA in pobj:
+                return typ.deserialize(pobj[DATA], supported=self.supported)
+            return typ.deserialize(pobj, supported=self.supported)
+        return pobj
+
+
+def unserializable(d: dict | list | tuple) -> list[tuple[list[Hashable], Any]]:
+    """Returns which items were unserializable. Useful to debug serializability.
+    """
+    lst = []
+    if isinstance(d, dict):
+        iters = d.items()
+    elif isinstance(d, (list, tuple)):
+        iters = enumerate(d)
+    else:
+        try:
+            json.dumps(d, cls=RampJSONEncoder)
+        except TypeError:
+            return [([], d)]
+        else:
+            return []
+
+    for a, b in iters:
+        if isinstance(b, (dict, list, tuple)):
+            lst.extend([([a] + access, v) for access, v in unserializable(b)])
+        else:
+            try:
+                json.dumps(b, cls=RampJSONEncoder)
+            except TypeError:
+                lst.append(([a], b))
+    return lst
+

ramp_core-0.0.4/ramp_core/serializable.py

@@ -0,0 +1,116 @@
+"""Defines the Serializable protocol, which is what we expect things to have, so we can serialize and deserialize them
+
+"""
+
+from pathlib import PurePath
+from typing import Any, ClassVar, Protocol, Sequence, Type, TypeVar, runtime_checkable
+
+try:  # To allow for older Python versions where Self was not supported
+    from typing import Self
+except ImportError:
+    Self = TypeVar("Self")
+
+import numpy as np
+from cytoolz import valmap
+
+T = TypeVar("T", bound="Serializable")
+D = TypeVar("D", bound="_Deserializable")
+
+
+class _Deserializable(Protocol):
+    @classmethod
+    def deserialize(cls: Type[D], d: dict[str, Any], *, supported: dict[str, Type["Serializable"]]) -> D:
+        ...
+
+
+@runtime_checkable
+class Serializable(Protocol):
+    """Protocol for classes that we can serialize to JSON-able formats and deserialize from.
+
+    Serializable objects must be capable of being equal to themselves by going through serialization and deserialization
+
+    """
+
+    ser_identifier: ClassVar[str]
+
+    def serialize(self) -> tuple[str, dict[str, Any]]:
+        """Serializes the object to return its class' identifier and the data that allows to recreate the instance.
+
+        Returns
+        -------
+        str, dict[str, data]
+            The ser_identifier and the data that allows to recreate an instance.
+
+        """
+        return self.ser_identifier, _ensure_list(_save_attributes(self))
+
+    @classmethod
+    def deserialize(cls: Type[Self], d: dict[str, Any], *, supported: dict[str, Type["Serializable"]]) -> Self:
+        """Create a new instance given the data generated by an instance's serialize method.
+
+        Parameters
+        ----------
+        d: dict[str, Any]
+            The data dictionary returned by the original object's serialize method.
+        supported: dict[str, Type[Serializable]]
+            A dictionary of which types are supported for deserialization.
+
+        """
+        return cls(**_default_tuple(d))
+
+    def __eq__(self: T, other: T) -> bool:
+        ...
+
+
+def deserialize_default(data: tuple[str, dict[str, Any]],
+                        supported: dict[str, Type[Serializable]],
+                        default: Type[_Deserializable] | None = None) -> _Deserializable:
+    """Deserialize the data given by a Serializable object's `serialize` method given class deserialization
+
+    Parameters
+    ----------
+    data: str, dict[str, Any]
+        The result from the object's Serialize method. See :func:Serializable.serialize.
+    supported: dict[str, Type[Serializable]]
+        A mapping of serialization identifiers to the classes they represent.
+    default: Type[Serializable] or None
+        The default type to use if the serialization identifier is not recognized. If None, raises an error if the
+        identifier isn't there.
+
+    Returns
+    -------
+    Serializable
+        The deserialized object
+
+    """
+    name, d = data
+    if default is not None:
+        typ = supported.get(name, default)
+    else:
+        if name not in supported:
+            raise TypeError(f"Deserialization of {name} from json isn't supported by the deserializer")
+        typ = supported[name]
+    return typ.deserialize(d, supported=supported)
+
+
+def _save_attributes(self) -> dict:
+    sd = {k: self.__getattribute__(k) for k in self.__slots__} if self.__slots__ else {}
+    return self.__dict__ | sd
+
+
+def _default_tuple(d: dict) -> dict:
+    return valmap(lambda x: tuple(x) if isinstance(x, list) else x, d)
+
+
+def _prefer_list(x):
+    if isinstance(x, Sequence) and not isinstance(x, str):
+        return list(x)
+    if isinstance(x, np.ndarray):
+        return x.tolist()
+    if isinstance(x, PurePath):
+        return str(x)
+    return x
+
+
+def _ensure_list(d: dict) -> dict:
+    return valmap(_prefer_list, d)

ramp_core-0.0.4/ramp_core/tempdir.py

@@ -0,0 +1,24 @@
+"""Temporary directory utilities
+
+"""
+import tempfile
+
+
+class TemporaryDirectory(tempfile.TemporaryDirectory):
+    """
+    like tempfile.TemporaryDirectory but with an optional argument to not
+    clean the directory afterwards.
+
+    """
+
+    def __init__(self, suffix=None, prefix=None, dir=None, clean_dir=True):
+        self.clean_dir = clean_dir
+        if self.clean_dir:
+            super(TemporaryDirectory, self).__init__(suffix=suffix, prefix=prefix, dir=dir)
+        else:
+            self.name = tempfile.mkdtemp(suffix, prefix, dir)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.clean_dir:
+            super(TemporaryDirectory, self).__exit__(exc_type, exc_val, exc_tb)
+

ramp_core-0.0.4/ramp_core.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: ramp-core
+Version: 0.0.4
+Summary: Utilities package for the Nuclear RAMP
+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
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cytoolz
+Requires-Dist: numpy
+Provides-Extra: test
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# ramp-core
+Welcome to the core utilities package of the nuclear Reactor Analysis
+Management Project!
+
+## Core utilities of RAMP
+
+This is where we handle serialization, pickling and such things that are used everywhere in the wide project.
+
+This package does almost nothing on its own, and one would usually only
+interact with it as a dependency.
+More often than not, people reading this will find other packages more
+useful, but you're welcome to contribute here too if you came all this
+way :)
+

ramp_core-0.0.4/ramp_core.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+.gitignore
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+LICENSE
+README.md
+pyproject.toml
+requirements.yml
+ruff.toml
+tests_requirements.yml
+.github/ISSUE_TEMPLATE/bug_report.md
+.github/ISSUE_TEMPLATE/documentation-improvement.md
+.github/ISSUE_TEMPLATE/feature_request.md
+.github/workflows/publish.yml
+.github/workflows/test.yml
+ramp_core/__init__.py
+ramp_core/json.py
+ramp_core/serializable.py
+ramp_core/tempdir.py
+ramp_core.egg-info/PKG-INFO
+ramp_core.egg-info/SOURCES.txt
+ramp_core.egg-info/dependency_links.txt
+ramp_core.egg-info/requires.txt
+ramp_core.egg-info/top_level.txt
+tests/test_prefer_list.py

ramp_core-0.0.4/ramp_core.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ramp_core-0.0.4/ramp_core.egg-info/requires.txt

@@ -0,0 +1,6 @@
+cytoolz
+numpy
+
+[test]
+hypothesis
+pytest

ramp_core-0.0.4/ramp_core.egg-info/top_level.txt

@@ -0,0 +1 @@
+ramp_core

ramp_core-0.0.4/requirements.yml

@@ -0,0 +1,3 @@
+dependencies:
+  - cytoolz
+  - numpy

ramp_core-0.0.4/ruff.toml

@@ -0,0 +1,5 @@
+lint.extend-select = ["I"]
+line-length = 120
+
+[lint.per-file-ignores]
+"*__init__.py" = ["F403", "I001"]

ramp_core-0.0.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ramp_core-0.0.4/tests/test_prefer_list.py

@@ -0,0 +1,20 @@
+from string import ascii_lowercase
+
+import hypothesis.strategies as st
+from hypothesis import given
+
+from ramp_core.serializable import _prefer_list
+
+
+@given(st.text(alphabet=ascii_lowercase, min_size=1))
+def test_prefer_list_for_str_is_str(sold):
+    s = _prefer_list(sold)
+    assert type(s) is str
+    assert s == sold
+
+
+@given(st.lists(elements=st.integers(), min_size=1).map(tuple))
+def test_prefer_list_for_tuple_is_list(x):
+    y = _prefer_list(x)
+    assert type(y) is list
+    assert all(yv == xv for yv, xv in zip(y, x))

ramp_core-0.0.4/tests_requirements.yml

@@ -0,0 +1,3 @@
+dependencies:
+  - pytest
+  - hypothesis