rodhypix 0.1.1__tar.gz

rodhypix-0.1.1/LICENSE

@@ -0,0 +1,32 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Robert Buecker
+
+Portions of this software (rod_image_reader.py) are adapted from dxtbx:
+Copyright (c) 2018-2023, United Kingdom Research and Innovation
+Copyright (c) 2022-2023, Takanori Nakane
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

rodhypix-0.1.1/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include scripts/*.py
+include rodhypix/*.cpp
+global-exclude __pycache__
+global-exclude *.py[co]

rodhypix-0.1.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: rodhypix
+Version: 0.1.1
+Summary: Standalone reader for Rigaku .rodhypix detector images
+Author-email: Robert Buecker <robert.buecker@rigaku.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/robertbuecker/rodhypix
+Project-URL: Repository, https://github.com/robertbuecker/rodhypix
+Project-URL: Issues, https://github.com/robertbuecker/rodhypix/issues
+Keywords: rodhypix,hypix,rigaku,crystallography,microed,3ded,crysalispro
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Provides-Extra: viz
+Requires-Dist: matplotlib>=3.3.0; extra == "viz"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# rodhypix
+
+Standalone reader for Rigaku `.rodhypix` detector images.
+
+## Features
+
+- Read native `.rodhypix` images without CrysAlisPro
+- Access detector and experiment metadata
+- Native C++ TY6 backend
+- Pure Python fallback
+
+## Installation
+
+```bash
+pip install rodhypix
+```
+
+On Windows, this will install native decompression from wheels without compilation.
+
+Plotting support (only required for example notebooks):
+
+```bash
+pip install "rodhypix[viz]"
+```
+
+## Quick Start
+
+```python
+from rodhypix import RODImageReader, get_rod_info, read_rod_image
+
+image = read_rod_image("snapshot.rodhypix")
+info = get_rod_info("snapshot.rodhypix")
+
+reader = RODImageReader("snapshot.rodhypix")
+print(reader.get_decompression_method())
+print(info["exposure_time_sec"])
+```
+
+## Public API
+
+- `RODImageReader`
+- `read_rod_image`
+- `get_rod_info`
+- `HAS_NATIVE_CPP`
+
+## Included Material
+
+- `rodhypix/rod_image_reader.py`: main reader implementation
+- `rodhypix/ty6_backend_tools.py`: backend comparison and benchmark helpers
+- `scripts/benchmark_ty6_backends.py`: CLI benchmark
+- `examples/01_image_visualization.ipynb`: image visualization notebook
+
+## Example Data
+
+The extracted example dataset is stored in `example_data/exp_11317.zip`.

rodhypix-0.1.1/README.md

@@ -0,0 +1,55 @@
+# rodhypix
+
+Standalone reader for Rigaku `.rodhypix` detector images.
+
+## Features
+
+- Read native `.rodhypix` images without CrysAlisPro
+- Access detector and experiment metadata
+- Native C++ TY6 backend
+- Pure Python fallback
+
+## Installation
+
+```bash
+pip install rodhypix
+```
+
+On Windows, this will install native decompression from wheels without compilation.
+
+Plotting support (only required for example notebooks):
+
+```bash
+pip install "rodhypix[viz]"
+```
+
+## Quick Start
+
+```python
+from rodhypix import RODImageReader, get_rod_info, read_rod_image
+
+image = read_rod_image("snapshot.rodhypix")
+info = get_rod_info("snapshot.rodhypix")
+
+reader = RODImageReader("snapshot.rodhypix")
+print(reader.get_decompression_method())
+print(info["exposure_time_sec"])
+```
+
+## Public API
+
+- `RODImageReader`
+- `read_rod_image`
+- `get_rod_info`
+- `HAS_NATIVE_CPP`
+
+## Included Material
+
+- `rodhypix/rod_image_reader.py`: main reader implementation
+- `rodhypix/ty6_backend_tools.py`: backend comparison and benchmark helpers
+- `scripts/benchmark_ty6_backends.py`: CLI benchmark
+- `examples/01_image_visualization.ipynb`: image visualization notebook
+
+## Example Data
+
+The extracted example dataset is stored in `example_data/exp_11317.zip`.

rodhypix-0.1.1/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "numpy>=1.20.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rodhypix"
+version = "0.1.1"
+description = "Standalone reader for Rigaku .rodhypix detector images"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "BSD-3-Clause"}
+authors = [
+    {name = "Robert Buecker", email = "robert.buecker@rigaku.com"}
+]
+keywords = ["rodhypix", "hypix", "rigaku", "crystallography", "microed", "3ded", "crysalispro"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Chemistry",
+]
+
+dependencies = [
+    "numpy>=1.20.0",
+]
+
+[project.optional-dependencies]
+viz = ["matplotlib>=3.3.0"]
+dev = [
+    "pytest>=7.0.0",
+    "black>=22.0.0",
+    "flake8>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/robertbuecker/rodhypix"
+Repository = "https://github.com/robertbuecker/rodhypix"
+Issues = "https://github.com/robertbuecker/rodhypix/issues"
+
+[tool.setuptools]
+packages = ["rodhypix"]
+
+[tool.setuptools.package-data]
+rodhypix = ["py.typed"]

rodhypix-0.1.1/rodhypix/__init__.py

@@ -0,0 +1,8 @@
+from .rod_image_reader import HAS_NATIVE_CPP, RODImageReader, get_rod_info, read_rod_image
+
+__all__ = [
+    "HAS_NATIVE_CPP",
+    "RODImageReader",
+    "get_rod_info",
+    "read_rod_image",
+]

rodhypix-0.1.1/rodhypix/py.typed

@@ -0,0 +1 @@
+