cuperiod 1.0.0__tar.gz

cuperiod-1.0.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+# autosummary stub pages are regenerated on every build (autosummary_generate=True)
+docs/api/generated/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

cuperiod-1.0.0/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to cuPeriod are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] — 2026-06-30
+
+First public release.
+
+### Added
+
+- Seven period-search methods, each with an optimized CPU backend and a CUDA GPU backend:
+  - **GLS** — generalized (floating-mean) Lomb–Scargle via non-uniform FFT
+    (finufft / cufinufft).
+  - **BLS** — box least squares, with a multicore `numba` CPU search (`[fast]` extra) and
+    a CUDA kernel.
+  - **PDM** — phase dispersion minimization (Stellingwerf).
+  - **CE** — conditional entropy (Graham et al. 2013).
+  - **String-Length** — Dworetsky / Lafler–Kinman.
+  - **MHAOV** — multiharmonic analysis of variance (Schwarzenberg-Czerny).
+  - **TLS** — transit least squares, a limb-darkened matched filter.
+- Single-light-curve entry point `cuperiod.periodogram` and the batch sibling
+  `cuperiod.batch_periodograms` (CPU process pool or GPU, resumable Parquet/CSV output).
+- Multi-band joint modelling for GLS, BLS, and MHAOV.
+- Frictionless inputs: arrays, dicts, pandas/astropy/pyarrow tables, and
+  CSV/ECSV/FITS/Parquet files, with case-insensitive, **survey-aware** column
+  auto-detection (`ColumnMap` — ASAS-SN, ASAS-3, ATLAS, CRTS/CSS, ZTF, Pan-STARRS, LSST,
+  TESS, Kepler, Gaia, MACHO) and domain-aware error pairing, plus automatic
+  magnitude/flux handling.
+- N-best-period peak finding with alias- and harmonic-aware selection.
+- `cuperiod` command-line interface: `run`, `batch`, `methods`, `gpu-info`, `grid-info`.
+- Per-method settings models with `CUPERIOD_<METHOD>_<FIELD>` environment overrides, and
+  GPU worker auto-sizing.
+- Full Sphinx documentation (hosted on Read the Docs), a worked-example Jupyter notebook
+  (`examples/cuperiod_tour.ipynb`), and a reproducible validation + benchmark suite under
+  `benchmarks/`.
+
+### Robustness
+
+- Peak selection returns the true peak even when it sits at a frequency-grid edge (a
+  signal whose period is comparable to the observing baseline), and never reports a
+  non-finite period or NaN-power sample.
+- Settings reject transposed frequency / period / duration-fraction bounds at
+  construction; the CLI's `--out` JSON is always standard JSON (no `NaN`/`Infinity`).
+- GPU kernels opt into larger shared memory where the device allows, and otherwise raise
+  a clear error naming the setting to reduce — instead of a raw CUDA driver error.
+- Batch sinks are correct across re-runs: a file sink is keyed by `(key, method)`, a
+  directory sink refuses a mismatched `chunk_size` on resume, and a CSV sink asked to
+  store raw spectra fails loudly rather than dropping the columns.
+- The batch process pool uses the `spawn` start method on every platform, so a CPU/GPU
+  pool no longer deadlocks on Linux (the default `fork` copies parent native thread pools
+  / CUDA contexts into the workers).
+- Method-name lookup ignores case and non-alphanumeric separators, so `"String-Length"`,
+  `"StringLength"` and `"STRINGLENGTH"` all resolve (as documented).
+
+### Validated
+
+- Every method matches an established reference (astropy `LombScargle` / `BoxLeastSquares`,
+  PyAstronomy, and textbook implementations) to floating-point round-off, with CPU↔GPU
+  parity, on 72 real ASAS-SN light curves across six variability classes and on confirmed
+  Kepler transits.
+
+[1.0.0]: https://github.com/tjayasinghe/cuPeriod/releases/tag/v1.0.0

cuperiod-1.0.0/CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+message: "If you use cuPeriod in your research, please cite it as below."
+title: cuPeriod
+abstract: >-
+  Optimized, GPU-accelerated periodograms for astronomy: seven period-search methods
+  (GLS, BLS, PDM, CE, String-Length, MHAOV, TLS) with fast CPU and CUDA backends, scaling
+  from a single light curve to millions.
+type: software
+authors:
+  - given-names: Tharindu
+    family-names: Jayasinghe
+    # Add your ORCID here to make the citation unambiguous, e.g.:
+    # orcid: "https://orcid.org/0000-0000-0000-0000"
+version: 1.0.0
+date-released: "2026-06-30"
+license: GPL-3.0-or-later
+repository-code: "https://github.com/tjayasinghe/cuPeriod"
+url: "https://cuperiod.readthedocs.io"
+keywords:
+  - astronomy
+  - periodogram
+  - lomb-scargle
+  - box-least-squares
+  - variable-stars
+  - time-series
+  - gpu
+  - cuda