Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
_commit: cac2bde
_commit: 86a1e5c
_src_path: gh:scipp/copier_template
description: Live data reduction visualisation framework for ESS.
max_python: '3.12'
min_python: '3.10'
namespace_package: ''
nightly_deps: scipp,sciline,plopp,scippneutron
nightly_deps: scipp,sciline,plopp,essreduce
orgname: scipp
prettyname: Beamlime
projectname: beamlime
related_projects: Scipp,Sciline,Plopp,ScippNeutron
related_projects: Scipp,Sciline,Plopp,Essreduce
year: 2024
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ jobs:
os-variant: ${{ matrix.os }}
python-version: ${{ matrix.python.version }}
tox-env: ${{ matrix.python.tox-env }}
secrets: inherit

docs:
needs: tests
Expand All @@ -54,3 +55,4 @@ jobs:
publish: false
linkcheck: ${{ contains(matrix.variant.os, 'ubuntu') && github.ref == 'refs/heads/main' }}
branch: ${{ github.head_ref == '' && github.ref_name || github.head_ref }}
secrets: inherit
6 changes: 5 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ jobs:
docs:
name: Build documentation
runs-on: 'ubuntu-22.04'
env:
ESS_PROTECTED_FILESTORE_USERNAME: ${{ secrets.ESS_PROTECTED_FILESTORE_USERNAME }}
ESS_PROTECTED_FILESTORE_PASSWORD: ${{ secrets.ESS_PROTECTED_FILESTORE_PASSWORD }}

steps:
- run: sudo apt install --yes graphviz pandoc
- uses: actions/checkout@v4
Expand All @@ -65,7 +69,7 @@ jobs:
name: docs_html
path: html/

- uses: JamesIves/github-pages-deploy-action@v4.6.1
- uses: JamesIves/github-pages-deploy-action@v4.6.3
if: ${{ inputs.publish }}
with:
branch: gh-pages
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/nightly_at_main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ jobs:
os-variant: ${{ matrix.os }}
python-version: ${{ matrix.python.version }}
tox-env: ${{ matrix.python.tox-env }}
secrets: inherit
1 change: 1 addition & 0 deletions .github/workflows/nightly_at_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ jobs:
python-version: ${{ matrix.python.version }}
tox-env: ${{ matrix.python.tox-env }}
checkout_ref: ${{ needs.setup.outputs.release_tag }}
secrets: inherit
18 changes: 18 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,26 @@ on:
type: string

jobs:
package-test:
runs-on: ${{ inputs.os-variant }}

steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.checkout_ref }}
- uses: actions/setup-python@v5
with:
python-version: ${{ inputs.python-version }}
- run: python -m pip install --upgrade pip
- run: python -m pip install .
- run: python tests/package_test.py
name: Run package tests

test:
runs-on: ${{ inputs.os-variant }}
env:
ESS_PROTECTED_FILESTORE_USERNAME: ${{ secrets.ESS_PROTECTED_FILESTORE_USERNAME }}
ESS_PROTECTED_FILESTORE_PASSWORD: ${{ secrets.ESS_PROTECTED_FILESTORE_PASSWORD }}

steps:
- uses: actions/checkout@v4
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/unpinned.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ jobs:
python-version: ${{ matrix.python.version }}
tox-env: ${{ matrix.python.tox-env }}
checkout_ref: ${{ needs.setup.outputs.release_tag }}
secrets: inherit
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ __pycache__/
.pytest_cache
.mypy_cache
docs/generated/
.ruff_cache

# Editor settings
.idea/
Expand Down
6 changes: 4 additions & 2 deletions conda/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ requirements:
- setuptools_scm
run:
- rich
- scippneutron>=24.03.0
- essreduce
- python>=3.10

{% for package in dependencies %}
Expand All @@ -33,11 +33,13 @@ test:
- pytest-asyncio
- psutil
- pandas
- pyarrow # Future hard-dependency of pandas, it can be removed from pandas>3.0
- numpy
- scipp
- plopp
- sciline
- scippneutron>=24.03.0
- essreduce
- pooch
source_files:
- pyproject.toml
- tests/
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/doc_version.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- This will display the version of the docs -->
Current {{ project }} version: {{ version }} (<a href="https://github.com/{{orgname}}/{{ project|lower }}/releases">older versions</a>).
Current Beamlime version: {{ version }} (<a href="https://github.com/scipp/beamlime/releases">older versions</a>).
20 changes: 17 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
import doctest
import os
import sys
from importlib.metadata import PackageNotFoundError
from importlib.metadata import version as get_version

from sphinx.util import logging

sys.path.insert(0, os.path.abspath('.'))

logger = logging.getLogger(__name__)

# General information about the project.
project = 'Beamlime'
copyright = '2024 Scipp contributors'
Expand Down Expand Up @@ -32,6 +37,8 @@
import sciline.sphinxext.domain_types # noqa: F401

extensions.append('sciline.sphinxext.domain_types')
# See https://github.com/tox-dev/sphinx-autodoc-typehints/issues/457
suppress_warnings = ["config.cache"]
except ModuleNotFoundError:
pass

Expand Down Expand Up @@ -109,8 +116,15 @@
# built documents.
#

release = get_version("beamlime")
version = ".".join(release.split('.')[:3]) # CalVer
try:
release = get_version("beamlime")
version = ".".join(release.split('.')[:3]) # CalVer
except PackageNotFoundError:
logger.info(
"Warning: determining version from package metadata failed, falling back to "
"a dummy version number."
)
release = version = "0.0.0-dev"

warning_is_error = True

Expand Down Expand Up @@ -149,10 +163,10 @@
"image_dark": "_static/logo-dark.svg",
},
"external_links": [
{"name": "Essreduce", "url": "https://scipp.github.io/essreduce"},
{"name": "Plopp", "url": "https://scipp.github.io/plopp"},
{"name": "Sciline", "url": "https://scipp.github.io/sciline"},
{"name": "Scipp", "url": "https://scipp.github.io"},
{"name": "ScippNeutron", "url": "https://scipp.github.io/scippneutron"},
],
"icon_links": [
{
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ requires-python = ">=3.10"
# Make sure to list one dependency per line.
dependencies = [
"rich",
"scippneutron>=24.03.0",
"essreduce",
]

dynamic = ["version"]
Expand Down
2 changes: 1 addition & 1 deletion requirements/base.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# --- END OF CUSTOM SECTION ---
# The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
rich
scippneutron>=24.03.0
essreduce
41 changes: 10 additions & 31 deletions requirements/base.txt
Original file line number Diff line number Diff line change
@@ -1,57 +1,36 @@
# SHA1:d16beb1d2c8626e90a075eda92b5c43d0a9625df
# SHA1:89978bb0fef0efd08032890f4d4bc4e3fd22eb53
#
# This file is autogenerated by pip-compile-multi
# To update, run:
#
# pip-compile-multi
#
certifi==2024.2.2
# via requests
charset-normalizer==3.3.2
# via requests
essreduce==24.8.0
# via -r base.in
h5py==3.11.0
# via
# scippneutron
# scippnexus
idna==3.7
# via requests
# via scippnexus
markdown-it-py==3.0.0
# via rich
mdurl==0.1.2
# via markdown-it-py
numpy==1.26.4
numpy==2.0.1
# via
# h5py
# scipp
# scippneutron
# scipy
packaging==24.0
# via pooch
platformdirs==4.2.2
# via pooch
pooch==1.8.1
# via scippneutron
pygments==2.18.0
# via rich
python-dateutil==2.9.0.post0
# via scippnexus
requests==2.32.2
# via pooch
rich==13.7.1
# via -r base.in
scipp==24.6.0
# via
# scippneutron
# scippnexus
scippneutron==24.3.0
# via -r base.in
scippnexus==24.3.1
# via scippneutron
scipy==1.13.1
# via
# scippneutron
# essreduce
# scippnexus
scippnexus==24.8.1
# via essreduce
scipy==1.14.0
# via scippnexus
six==1.16.0
# via python-dateutil
urllib3==2.2.1
# via requests
3 changes: 2 additions & 1 deletion requirements/basetest.in
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ psutil
pandas
pyarrow # Future hard-dependency of pandas, it can be removed from pandas>3.0
scipp
scippneutron
essreduce
plopp
pooch
Loading