- Validate and check NeXus files
-
+
+ Validate and check NeXus files
+
-## Install
+## Installation
+
+To install Chexus and all of its dependencies, use
`````{tab-set}
````{tab-item} pip
@@ -50,6 +61,11 @@ There is also a Python API, but this is under construction and unstable.
- `--exit-on-fail`: Return a non-zero exit code if validation fails.
- `-r`, `--root-path`: Path to the top-level group to validate. Default is `''`.
+## Get in touch
+
+- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/chexus/discussions). Please include a self-contained reproducible example if possible.
+- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/chexus).
+
```{toctree}
---
hidden:
diff --git a/pyproject.toml b/pyproject.toml
index 99fcd08..7c344bc 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,6 +21,7 @@ classifiers = [
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
+ "Programming Language :: Python :: 3.13",
"Topic :: Scientific/Engineering",
"Typing :: Typed",
]
@@ -80,13 +81,12 @@ ignore = [
# https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
"COM812", "COM819", "D206", "D300", "E111", "E114", "E117", "ISC001", "ISC002", "Q000", "Q001", "Q002", "Q003", "W191",
]
-fixable = ["B010", "I001", "PT001"]
+fixable = ["B010", "I001", "PT001", "RUF022"]
isort.known-first-party = ["chexus"]
pydocstyle.convention = "numpy"
[tool.ruff.lint.per-file-ignores]
# those files have an increased risk of relying on import order
-"__init__.py" = ["I"]
"tests/*" = [
"S101", # asserts are fine in tests
"B018", # 'useless expressions' are ok because some tests just check for exceptions
diff --git a/requirements/make_base.py b/requirements/make_base.py
index ccbab00..2cda547 100644
--- a/requirements/make_base.py
+++ b/requirements/make_base.py
@@ -1,4 +1,3 @@
-import sys
from argparse import ArgumentParser
from pathlib import Path
@@ -58,16 +57,22 @@ def as_nightly(repo: str) -> str:
else:
org = "scipp"
if repo == "scipp":
- version = f"cp{sys.version_info.major}{sys.version_info.minor}"
- base = "https://github.com/scipp/scipp/releases/download/nightly/scipp-nightly"
- suffix = "manylinux_2_17_x86_64.manylinux2014_x86_64.whl"
- prefix = "scipp @ "
- return prefix + "-".join([base, version, version, suffix])
+ # With the standard pip resolver index-url takes precedence over
+ # extra-index-url but with uv it's reversed, so if we move to tox-uv
+ # this needs to be reversed.
+ return (
+ "scipp\n"
+ "--index-url=https://pypi.anaconda.org/scipp-nightly-wheels/simple/\n"
+ "--extra-index-url=https://pypi.org/simple\n"
+ "--pre"
+ )
return f"{repo} @ git+https://github.com/{org}/{repo}@main"
nightly = tuple(args.nightly.split(",") if args.nightly else [])
-nightly_dependencies = [dep for dep in dependencies if not dep.startswith(nightly)]
+nightly_dependencies = [
+ dep for dep in dependencies + test_dependencies if not dep.startswith(nightly)
+]
nightly_dependencies += [as_nightly(arg) for arg in nightly]
write_dependencies("nightly", nightly_dependencies)
diff --git a/requirements/nightly.in b/requirements/nightly.in
index e06d2a9..0536b92 100644
--- a/requirements/nightly.in
+++ b/requirements/nightly.in
@@ -1,4 +1,3 @@
--r basetest.in
# --- END OF CUSTOM SECTION ---
# The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
h5py
diff --git a/src/chexus/__init__.py b/src/chexus/__init__.py
index 38fd077..c3840a4 100644
--- a/src/chexus/__init__.py
+++ b/src/chexus/__init__.py
@@ -1,6 +1,6 @@
# SPDX-License-Identifier: BSD-3-Clause
-# Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
-# ruff: noqa: E402, F401
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
+# ruff: noqa: E402, F401, I
import importlib.metadata
diff --git a/tests/package_test.py b/tests/package_test.py
index 0ba42e4..6931e49 100644
--- a/tests/package_test.py
+++ b/tests/package_test.py
@@ -1,5 +1,5 @@
# SPDX-License-Identifier: BSD-3-Clause
-# Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
"""Tests of package integrity.
diff --git a/tox.ini b/tox.ini
index 19022c6..2aef2be 100644
--- a/tox.ini
+++ b/tox.ini
@@ -10,6 +10,9 @@ commands = pytest {posargs}
[testenv:nightly]
deps = -r requirements/nightly.txt
+setenv =
+ PIP_INDEX_URL = https://pypi.anaconda.org/scipp-nightly-wheels/simple
+ PIP_EXTRA_INDEX_URL = https://pypi.org/simple
commands = pytest {posargs}
[testenv:unpinned]
@@ -61,7 +64,9 @@ description = Update dependencies by running pip-compile-multi
deps =
pip-compile-multi
tomli
+ # Avoid https://github.com/jazzband/pip-tools/issues/2131
+ pip==24.2
skip_install = true
changedir = requirements
commands = python ./make_base.py --nightly scipp
- pip-compile-multi -d . --backtracking
+ pip-compile-multi -d . --backtracking --annotate-index