pybinny 0.1.1__tar.gz

pybinny-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nikolina Sarcevic
+
+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.

pybinny-0.1.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: pybinny
+Version: 0.1.1
+Summary: Flexible tomographic binning algorithms for cosmology.
+Author-email: Nikolina Sarcevic <nikolina.sarcevic@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pyyaml
+Requires-Dist: scipy
+Requires-Dist: cmasher
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=0.26; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: tox>=4.22; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx[doctest]<9; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-multiversion; extra == "docs"
+Requires-Dist: sphinxawesome-theme; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Dynamic: license-file
+
+<p align="center">
+  <img src="docs/_static/animations/binny_logo.gif" width="220">
+</p>
+
+# binny
+
+<p align="center">
+
+[![CI](https://github.com/binny-org/binny/actions/workflows/ci.yml/badge.svg)](https://github.com/binny-org/binny/actions/workflows/ci.yml)
+[![Deploy Sphinx Documentation](https://github.com/binny-org/binny/actions/workflows/docs.yml/badge.svg)](https://github.com/binny-org/binny/actions/workflows/docs.yml)
+[![codecov](https://codecov.io/gh/binny-org/binny/branch/main/graph/badge.svg)](https://codecov.io/gh/binny-org/binny)
+[![License](https://img.shields.io/github/license/binny-org/binny)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-binny-fde725?style=for-the-badge)](https://binny-org.github.io/binny)
+
+
+</p>
+
+**binny** is a Python library for constructing and analyzing  
+**tomographic redshift bins** used in cosmology and large-scale structure analyses.
+
+It provides flexible binning algorithms, validation utilities, and diagnostic tools
+for forecasting, inference pipelines, and survey analysis workflows.
+
+---
+
+# Installation
+
+### Install from source
+
+```bash
+git clone https://github.com/binny-org/binny.git
+cd binny
+python -m pip install -e .
+````
+
+### Development install
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+---
+
+
+# Citation
+
+If you use **binny** in your research, please cite it.
+
+```bibtex
+@software{sarcevic2026binny,
+  title   = {binny: Flexible binning algorithms for cosmology},
+  author  = {Šarčević, Nikolina and van der Wild, Matthijs},
+  year    = {2026},
+  url     = {https://github.com/binny-org/binny}
+}
+```
+
+Citation metadata is also available in `CITATION.cff`, which GitHub uses to generate citation formats automatically.
+
+---
+
+# Contributing
+
+Contributions are very welcome.
+See the **Contributing** guide in the documentation for development workflow,
+testing, and code style guidelines.
+
+---
+
+# License
+
+MIT License © 2026 Nikolina Šarčević, Matthijs van der Wild and contributors.
+

pybinny-0.1.1/README.md

@@ -0,0 +1,73 @@
+<p align="center">
+  <img src="docs/_static/animations/binny_logo.gif" width="220">
+</p>
+
+# binny
+
+<p align="center">
+
+[![CI](https://github.com/binny-org/binny/actions/workflows/ci.yml/badge.svg)](https://github.com/binny-org/binny/actions/workflows/ci.yml)
+[![Deploy Sphinx Documentation](https://github.com/binny-org/binny/actions/workflows/docs.yml/badge.svg)](https://github.com/binny-org/binny/actions/workflows/docs.yml)
+[![codecov](https://codecov.io/gh/binny-org/binny/branch/main/graph/badge.svg)](https://codecov.io/gh/binny-org/binny)
+[![License](https://img.shields.io/github/license/binny-org/binny)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-binny-fde725?style=for-the-badge)](https://binny-org.github.io/binny)
+
+
+</p>
+
+**binny** is a Python library for constructing and analyzing  
+**tomographic redshift bins** used in cosmology and large-scale structure analyses.
+
+It provides flexible binning algorithms, validation utilities, and diagnostic tools
+for forecasting, inference pipelines, and survey analysis workflows.
+
+---
+
+# Installation
+
+### Install from source
+
+```bash
+git clone https://github.com/binny-org/binny.git
+cd binny
+python -m pip install -e .
+````
+
+### Development install
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+---
+
+
+# Citation
+
+If you use **binny** in your research, please cite it.
+
+```bibtex
+@software{sarcevic2026binny,
+  title   = {binny: Flexible binning algorithms for cosmology},
+  author  = {Šarčević, Nikolina and van der Wild, Matthijs},
+  year    = {2026},
+  url     = {https://github.com/binny-org/binny}
+}
+```
+
+Citation metadata is also available in `CITATION.cff`, which GitHub uses to generate citation formats automatically.
+
+---
+
+# Contributing
+
+Contributions are very welcome.
+See the **Contributing** guide in the documentation for development workflow,
+testing, and code style guidelines.
+
+---
+
+# License
+
+MIT License © 2026 Nikolina Šarčević, Matthijs van der Wild and contributors.
+

pybinny-0.1.1/pyproject.toml

@@ -0,0 +1,167 @@
+[project]
+name = "pybinny"
+version = "0.1.1"
+description = "Flexible tomographic binning algorithms for cosmology."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "Nikolina Sarcevic", email = "nikolina.sarcevic@gmail.com" }]
+
+dependencies = [
+  "numpy",
+  "pyyaml",
+  "scipy",
+  "cmasher",
+]
+
+[project.optional-dependencies]
+dev = [
+  "bump-my-version>=0.26",
+  "pytest>=8",
+  "pytest-cov>=5",
+  "ruff>=0.6",
+  "tox>=4.22",
+]
+docs = [
+  "sphinx[doctest]<9",
+  "sphinx-copybutton",
+  "sphinx-design",
+  "sphinx-multiversion",
+  "sphinxawesome-theme",
+  "furo",
+]
+
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[tool.coverage.run]
+branch = true
+parallel = true
+source = ["binny"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "raise NotImplementedError",
+]
+fail_under = 90
+show_missing = true
+skip_empty = true
+
+[tool.pytest.ini_options]
+addopts = "-m 'not slow'"
+markers = [
+  "slow: long-running tests (opt-in)",
+  "regression: heavier regression / sweep tests (opt-in)",
+]
+testpaths = ["tests"]
+
+[tool.ruff]
+exclude = [
+  "benchmarks",
+  "docs",
+]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "double"
+
+[tool.ruff.lint]
+select = ["B", "E", "F", "I", "UP"]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"binny.surveys" = ["configs/*.yaml"]
+
+[tool.bumpversion]
+commit = true
+current_version = "0.1.1"
+tag = true
+
+[tool.bumpversion.files."pyproject.toml"]
+replace = 'version = "{new_version}"'
+search = 'version = "{current_version}"'
+
+
+[tool.tox]
+requires = ["tox>=4.22"]
+envlist = [
+  "py312",
+  "cov",
+  "cov-strict",
+  "docs",
+  "do",
+  "docs-releases",
+]
+
+[tool.tox.env_run_base.setenv]
+PIP_CACHE_DIR = "{tox_root}/.cache/pip"
+
+[tool.tox.env.py312]
+description = "Run unit tests"
+extras = ["dev"]
+commands = [
+  ["pytest", "-q"],
+]
+
+[tool.tox.env.cov]
+description = "Coverage report for dev (does not fail)"
+extras = ["dev"]
+commands = [
+  [
+    "pytest",
+    "-q",
+    "--cov=binny",
+    "--cov-branch",
+    "--cov-report=term-missing:skip-covered",
+    "--cov-fail-under=0",
+  ],
+]
+
+[tool.tox.env.cov-strict]
+description = "Coverage gate (fails if below fail_under)"
+extras = ["dev"]
+commands = [
+  [
+    "pytest",
+    "-q",
+    "--cov=binny",
+    "--cov-branch",
+    "--cov-report=term-missing:skip-covered",
+  ],
+]
+
+[tool.tox.env.docs]
+description = "Build the HTML files for the current state using Sphinx"
+extras = ["docs"]
+commands = [
+  ["sphinx-build", "{tox_root}/docs", "{tox_root}/docs/_build/html", "--fail-on-warning"],
+]
+
+[tool.tox.env.do]
+description = "Run doctests and build the HTML docs"
+extras = ["docs"]
+allowlist_externals = ["open"]
+commands = [
+  ["sphinx-build", "-b", "doctest", "{tox_root}/docs", "{tox_root}/docs/_build/doctest", "--fail-on-warning"],
+  ["sphinx-build", "-b", "html", "{tox_root}/docs", "{tox_root}/docs/_build/html", "--fail-on-warning"],
+  ["open", "{tox_root}/docs/_build/html/index.html"],
+]
+
+[tool.tox.env.docs-releases]
+description = "Build the documentation for binny releases using Sphinx"
+extras = ["docs"]
+allowlist_externals = ["cp"]
+commands = [
+  ["sphinx-multiversion", "{tox_root}/docs", "{tox_root}/docs/_build/html", "--fail-on-warning"],
+  ["cp", "{tox_root}/docs/_templates/pages_redirect.html", "{tox_root}/docs/_build/html/index.html"],
+]

pybinny-0.1.1/setup.cfg

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

pybinny-0.1.1/src/binny/__init__.py

@@ -0,0 +1,10 @@
+"""Public Binny API."""
+
+from __future__ import annotations
+
+from binny import api as _api
+
+# Re-export public API symbols explicitly
+__all__ = list(_api.__all__)
+
+globals().update({name: getattr(_api, name) for name in __all__})

pybinny-0.1.1/src/binny/api/__init__.py

@@ -0,0 +1,19 @@
+"""Initialization of the Binny API package."""
+
+from __future__ import annotations
+
+from importlib import import_module
+
+_API_MODULES = ("binny.api.nz_tomography",)
+
+__all__: list[str] = []
+
+for mod_name in _API_MODULES:
+    mod = import_module(mod_name)
+    names = list(getattr(mod, "__all__", []))
+    for name in names:
+        globals()[name] = getattr(mod, name)
+    __all__.extend(names)
+
+# remove duplicates and make ordering stable
+__all__ = sorted(set(__all__))