nexsci-rv 1.0.0__tar.gz

nexsci_rv-1.0.0/.gitignore

@@ -0,0 +1,68 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+
+# venvs
+.venv/
+venv/
+env/
+
+# Tests / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+*.cover
+
+# mypy / ruff caches
+.mypy_cache/
+.ruff_cache/
+
+# Docs build output (Sphinx + legacy MkDocs)
+site/
+.cache/
+docs/_build/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Notebook download outputs (created when tutorials run live)
+docs/tutorials/data/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Secrets / local artifacts (defense in depth — should never exist anyway)
+*.cookie
+cookie
+neid_cookie.txt
+neidadmincookie.txt
+.env
+.env.*
+
+# Internal IPAC policy docs — never publish
+Open Sourcing Software*.pdf
+
+# IPAC open-sourcing paperwork — contains signatures/personal info, never publish
+SoftwareDisclosure*.pdf
+IPAC-Public-Repository-Request*.pdf
+nexsci-rv_OTTCP_disclosure_description.*
+OTTCP_submission_*/
+
+# Local tooling binaries that must never be committed
+dcp-cert-util

nexsci_rv-1.0.0/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+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).
+
+## [Unreleased]
+
+## [1.0.0] — 2026-10-27
+
+First public release.
+
+### Added
+- `NEIDArchive` backend covering NEID L0/L1/L2, engineering, and solar tables.
+- `EXPRESArchive` backend covering EXPRES solar L1 and L2.
+- Shared core: TAP client, cookie-based `SessionManager`, parallel `download()` with
+  retry and resume, `AsyncJob` for async TAP queries.
+- Sphinx (MyST) documentation on GitHub Pages, written for astronomers new to
+  RV archives: quickstart, a guided "first query" page, an "Understanding the
+  data" concepts layer, glossary, per-archive pages, guides, and API reference.
+- Three tutorial notebooks under `docs/tutorials/`, exercised in CI via
+  `nbmake` in an offline stub mode (`NEXSCI_RV_OFFLINE_FIXTURES=1`).
+- Support section pointing to `neid-help@ipac.caltech.edu` and GitHub Issues.
+
+### Fixed
+- `NEIDArchive.query_datetime` filtered on a nonexistent `date_obs` column
+  (server error `ORA-00904`); NEID tables use `obsdate`, as EXPRES does.
+- `download()` ignored the `server=` override and always fetched from the
+  production host; downloads now go to the same server as queries and login,
+  for both NEID and EXPRES.
+
+### Security
+- Pre-release audit with remediations applied: EXPRES query gaps raise
+  `NotApplicable`, cookie-file race fix, defusedxml documentation,
+  pip-audit clean. User-facing credential guidance lives in the
+  Authentication guide.
+
+### Relationship to pyNEID
+`nexsci-rv` is a clean-room successor to the
+[pyNEID](https://github.com/Caltech-IPAC/pyNEID) package. It is **not** API
+compatible. Motivations for the rewrite:
+
+- Multi-archive support (NEID + EXPRES, with extensibility for more) rather
+  than NEID-only.
+- New PyPI project (the original `pyneid` PyPI account is no longer accessible).
+- Cleaner internal architecture: archive-backends + shared core, replacing a
+  3,900-line monolithic `core.py`.
+- Modern packaging (`pyproject.toml`, ruff, mypy, GitHub Actions, Trusted Publishing).
+- Polished auth (per-archive cookies in `~/.config/nexsci-rv/`, env-var
+  credentials, `getpass` prompts, 0600 file mode).
+- Default server is the NEID production server.
+
+Existing pyNEID users should migrate by rewriting imports and call sites. There
+is no compatibility shim.

nexsci_rv-1.0.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Caltech-IPAC
+
+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.

nexsci_rv-1.0.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.5
+Name: nexsci-rv
+Version: 1.0.0
+Summary: Python client for the radial-velocity data archives hosted at NExScI.
+Project-URL: Homepage, https://github.com/Caltech-IPAC/nexsci-rv
+Project-URL: Documentation, https://caltech-ipac.github.io/nexsci-rv/
+Project-URL: Repository, https://github.com/Caltech-IPAC/nexsci-rv
+Project-URL: Issues, https://github.com/Caltech-IPAC/nexsci-rv/issues
+Author-email: BJ Fulton <bjfulton@ipac.caltech.edu>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2026, Caltech-IPAC
+        
+        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.
+License-File: LICENSE
+Keywords: astronomy,expres,ivoa,neid,nexsci,radial-velocity,spectroscopy,tap
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.10
+Requires-Dist: astropy>=6.0
+Requires-Dist: defusedxml>=0.7
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: requests>=2.31
+Requires-Dist: tqdm>=4.66
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pip-audit>=2.7; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-vcr>=1.0.2; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff<0.16,>=0.15; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Requires-Dist: vcrpy>=6.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: ipykernel>=6.29; extra == 'docs'
+Requires-Dist: linkify-it-py>=2.0; extra == 'docs'
+Requires-Dist: matplotlib>=3.8; extra == 'docs'
+Requires-Dist: myst-nb>=1.1; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx<9,>=7.2; extra == 'docs'
+Provides-Extra: notebooks
+Requires-Dist: jupyter>=1.0; extra == 'notebooks'
+Requires-Dist: matplotlib>=3.8; extra == 'notebooks'
+Requires-Dist: nbmake>=1.5; extra == 'notebooks'
+Description-Content-Type: text/markdown
+
+# nexsci-rv
+
+A Python client for radial-velocity data archives hosted at [NExScI](https://nexsci.caltech.edu/).
+
+[![Docs](https://github.com/Caltech-IPAC/nexsci-rv/actions/workflows/docs.yml/badge.svg)](https://caltech-ipac.github.io/nexsci-rv/)
+
+📖 **Documentation:** <https://caltech-ipac.github.io/nexsci-rv/>
+
+**Status:** stable (`1.0.0`). The public API follows [Semantic Versioning](https://semver.org/): breaking changes only in a new major version.
+
+`nexsci-rv` gives every supported archive the same interface: search
+observations by date, position, target, or program, get the results back as
+an `astropy` table, and download the data products you need.
+
+## Supported archives
+
+| Archive | Data levels | Auth |
+|---|---|---|
+| NEID    | L0, L1, L2, eng, solar L0/L1/L2/eng | cookie-based login (public access without) |
+| EXPRES  | solar L1, solar L2                  | public |
+
+## Install
+
+```bash
+pip install nexsci-rv
+# or, from source:
+pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```python
+from nexsci_rv import NEIDArchive, EXPRESArchive
+
+neid = NEIDArchive()
+table = neid.query_datetime("l2", ("2024-11-01", "2024-11-06"))
+print(table)
+
+expres = EXPRESArchive()
+sun = expres.query_datetime(
+    "solarl2",
+    ("2024-11-01", "2024-11-06"),
+    columns=["l2filename", "obsdate", "v", "e_v", "dvrms", "extsnr"],
+)
+print(sun)
+```
+
+See the [quickstart](https://caltech-ipac.github.io/nexsci-rv/quickstart.html) and the [tutorials](https://caltech-ipac.github.io/nexsci-rv/tutorials/01_neid_query_l2.html) in the documentation.
+
+## Predecessor
+
+`nexsci-rv` is a clean-room successor to [pyNEID](https://github.com/Caltech-IPAC/pyNEID). It is **not** API-compatible — see the [changelog](https://github.com/Caltech-IPAC/nexsci-rv/blob/main/CHANGELOG.md) for the rationale.
+
+## Support
+
+Questions, bug reports, and feature requests are welcome:
+
+- **Email:** <neid-help@ipac.caltech.edu> — the NEID/NExScI archive helpdesk, and the
+  best route for questions about the data itself or about archive access.
+- **GitHub Issues:** <https://github.com/Caltech-IPAC/nexsci-rv/issues> — for bugs in
+  this client library.
+
+Please do not include passwords or session cookies in an issue or an email.
+
+## License
+
+BSD 3-Clause. See [`LICENSE`](https://github.com/Caltech-IPAC/nexsci-rv/blob/main/LICENSE).

nexsci_rv-1.0.0/README.md

@@ -0,0 +1,67 @@
+# nexsci-rv
+
+A Python client for radial-velocity data archives hosted at [NExScI](https://nexsci.caltech.edu/).
+
+[![Docs](https://github.com/Caltech-IPAC/nexsci-rv/actions/workflows/docs.yml/badge.svg)](https://caltech-ipac.github.io/nexsci-rv/)
+
+📖 **Documentation:** <https://caltech-ipac.github.io/nexsci-rv/>
+
+**Status:** stable (`1.0.0`). The public API follows [Semantic Versioning](https://semver.org/): breaking changes only in a new major version.
+
+`nexsci-rv` gives every supported archive the same interface: search
+observations by date, position, target, or program, get the results back as
+an `astropy` table, and download the data products you need.
+
+## Supported archives
+
+| Archive | Data levels | Auth |
+|---|---|---|
+| NEID    | L0, L1, L2, eng, solar L0/L1/L2/eng | cookie-based login (public access without) |
+| EXPRES  | solar L1, solar L2                  | public |
+
+## Install
+
+```bash
+pip install nexsci-rv
+# or, from source:
+pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```python
+from nexsci_rv import NEIDArchive, EXPRESArchive
+
+neid = NEIDArchive()
+table = neid.query_datetime("l2", ("2024-11-01", "2024-11-06"))
+print(table)
+
+expres = EXPRESArchive()
+sun = expres.query_datetime(
+    "solarl2",
+    ("2024-11-01", "2024-11-06"),
+    columns=["l2filename", "obsdate", "v", "e_v", "dvrms", "extsnr"],
+)
+print(sun)
+```
+
+See the [quickstart](https://caltech-ipac.github.io/nexsci-rv/quickstart.html) and the [tutorials](https://caltech-ipac.github.io/nexsci-rv/tutorials/01_neid_query_l2.html) in the documentation.
+
+## Predecessor
+
+`nexsci-rv` is a clean-room successor to [pyNEID](https://github.com/Caltech-IPAC/pyNEID). It is **not** API-compatible — see the [changelog](https://github.com/Caltech-IPAC/nexsci-rv/blob/main/CHANGELOG.md) for the rationale.
+
+## Support
+
+Questions, bug reports, and feature requests are welcome:
+
+- **Email:** <neid-help@ipac.caltech.edu> — the NEID/NExScI archive helpdesk, and the
+  best route for questions about the data itself or about archive access.
+- **GitHub Issues:** <https://github.com/Caltech-IPAC/nexsci-rv/issues> — for bugs in
+  this client library.
+
+Please do not include passwords or session cookies in an issue or an email.
+
+## License
+
+BSD 3-Clause. See [`LICENSE`](https://github.com/Caltech-IPAC/nexsci-rv/blob/main/LICENSE).

nexsci_rv-1.0.0/pyproject.toml

@@ -0,0 +1,147 @@
+[build-system]
+requires = ["hatchling>=1.21"]
+build-backend = "hatchling.build"
+
+[project]
+name = "nexsci-rv"
+version = "1.0.0"
+description = "Python client for the radial-velocity data archives hosted at NExScI."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10"
+authors = [
+    { name = "BJ Fulton", email = "bjfulton@ipac.caltech.edu" },
+]
+keywords = ["astronomy", "radial-velocity", "spectroscopy", "neid", "expres", "nexsci", "tap", "ivoa"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+dependencies = [
+    "astropy>=6.0",
+    "requests>=2.31",
+    "platformdirs>=4.0",
+    "tqdm>=4.66",
+    "defusedxml>=0.7",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "pytest-vcr>=1.0.2",
+    "vcrpy>=6.0",
+    # Pinned below 0.16: 0.16 began formatting Python code blocks inside
+    # Markdown, which would reformat the docs tree. Revisit deliberately.
+    "ruff>=0.15,<0.16",
+    "mypy>=1.10",
+    "types-requests",
+    "pre-commit>=3.7",
+    "pip-audit>=2.7",
+]
+docs = [
+    "sphinx>=7.2,<9",
+    "myst-nb>=1.1",
+    "sphinx-rtd-theme>=2.0",
+    "sphinx-copybutton>=0.5",
+    "linkify-it-py>=2.0",
+    "ipykernel>=6.29",
+    "matplotlib>=3.8",
+]
+notebooks = [
+    "jupyter>=1.0",
+    "matplotlib>=3.8",
+    "nbmake>=1.5",
+]
+
+[project.urls]
+Homepage = "https://github.com/Caltech-IPAC/nexsci-rv"
+Documentation = "https://caltech-ipac.github.io/nexsci-rv/"
+Repository = "https://github.com/Caltech-IPAC/nexsci-rv"
+Issues = "https://github.com/Caltech-IPAC/nexsci-rv/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/nexsci_rv"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/nexsci_rv",
+    "tests",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "pyproject.toml",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E", "F", "W",   # pycodestyle / pyflakes
+    "I",             # isort
+    "B",             # bugbear
+    "UP",            # pyupgrade
+    "SIM",           # simplify
+    "RUF",           # ruff-specific
+    "S",             # bandit (security)
+]
+ignore = [
+    "E501",          # line length handled by formatter
+    "S101",          # asserts in tests
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["S101", "S105", "S106", "S311"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_unreachable = true
+warn_unused_ignores = true
+disallow_untyped_defs = true
+files = ["src/nexsci_rv"]
+
+[[tool.mypy.overrides]]
+module = ["astropy.*", "vcr.*", "tqdm.*", "defusedxml.*"]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+testpaths = ["tests"]
+addopts = [
+    "-ra",
+    "--strict-markers",
+    "--strict-config",
+]
+markers = [
+    "network: integration tests that hit the live NEID server",
+    "slow: tests slower than a few seconds",
+]
+
+[tool.coverage.run]
+source = ["src/nexsci_rv"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "\\.\\.\\.",
+]
+fail_under = 85

nexsci_rv-1.0.0/src/nexsci_rv/__init__.py

@@ -0,0 +1,54 @@
+"""nexsci-rv — Python client for radial-velocity archives at NExScI."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from . import exceptions
+from .archives.expres import EXPRESArchive
+from .archives.neid import NEIDArchive
+from .async_job import AsyncJob
+from .base import BaseArchive
+from .config import Conf, conf
+from .exceptions import (
+    AsyncJobError,
+    AuthError,
+    AuthExpired,
+    ConfigError,
+    DownloadError,
+    LoginFailed,
+    NexsciRVError,
+    NotApplicable,
+    NotAuthenticated,
+    QueryError,
+    TapServerError,
+    UnknownColumn,
+    UnknownDataLevel,
+)
+
+try:
+    __version__ = version("nexsci-rv")
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0+unknown"
+
+__all__ = [
+    "AsyncJob",
+    "AsyncJobError",
+    "AuthError",
+    "AuthExpired",
+    "BaseArchive",
+    "Conf",
+    "ConfigError",
+    "DownloadError",
+    "EXPRESArchive",
+    "LoginFailed",
+    "NEIDArchive",
+    "NexsciRVError",
+    "NotApplicable",
+    "NotAuthenticated",
+    "QueryError",
+    "TapServerError",
+    "UnknownColumn",
+    "UnknownDataLevel",
+    "__version__",
+    "conf",
+    "exceptions",
+]