essdiffraction 25.6.0__tar.gz → 25.9.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (156) hide show
  1. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.copier-answers.yml +2 -2
  2. essdiffraction-25.9.0/.github/workflows/nightly_at_main_lower_bound.yml +37 -0
  3. essdiffraction-25.9.0/.github/workflows/python-version-ci +1 -0
  4. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/release.yml +2 -42
  5. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.pre-commit-config.yaml +0 -1
  6. essdiffraction-25.9.0/.python-version +1 -0
  7. {essdiffraction-25.6.0/src/essdiffraction.egg-info → essdiffraction-25.9.0}/PKG-INFO +12 -12
  8. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/README.md +1 -1
  9. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/about/index.md +2 -2
  10. essdiffraction-25.9.0/docs/api-reference/index.md +153 -0
  11. essdiffraction-25.9.0/docs/bibliography.bib +20 -0
  12. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/conf.py +27 -17
  13. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/developer/getting-started.md +1 -1
  14. essdiffraction-25.9.0/docs/user-guide/beer/beer_modulation_mcstas.ipynb +648 -0
  15. essdiffraction-25.9.0/docs/user-guide/beer/index.md +10 -0
  16. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/dream-advanced-powder-reduction.ipynb +1 -1
  17. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/dream-instrument-view.ipynb +4 -40
  18. {essdiffraction-25.6.0/tools → essdiffraction-25.9.0/docs/user-guide/dream}/dream-make-tof-lookup-table.ipynb +10 -10
  19. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/index.md +1 -0
  20. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/index.md +1 -0
  21. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/installation.md +1 -1
  22. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/pyproject.toml +10 -10
  23. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/base.in +5 -5
  24. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/base.txt +30 -30
  25. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/basetest.in +4 -3
  26. essdiffraction-25.9.0/requirements/basetest.txt +91 -0
  27. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/ci.txt +10 -16
  28. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/dev.txt +18 -14
  29. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/docs.in +1 -0
  30. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/docs.txt +25 -18
  31. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/mypy.txt +3 -3
  32. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/nightly.in +7 -6
  33. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/nightly.txt +33 -36
  34. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/static.txt +4 -4
  35. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/test.txt +2 -2
  36. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/wheels.txt +3 -5
  37. essdiffraction-25.9.0/src/ess/beer/__init__.py +30 -0
  38. essdiffraction-25.9.0/src/ess/beer/clustering.py +58 -0
  39. essdiffraction-25.9.0/src/ess/beer/conversions.py +194 -0
  40. essdiffraction-25.9.0/src/ess/beer/data.py +95 -0
  41. essdiffraction-25.9.0/src/ess/beer/io.py +172 -0
  42. essdiffraction-25.9.0/src/ess/beer/types.py +41 -0
  43. essdiffraction-25.9.0/src/ess/beer/workflow.py +43 -0
  44. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/__init__.py +14 -4
  45. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/data.py +34 -34
  46. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/instrument_view.py +1 -1
  47. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/io/__init__.py +1 -2
  48. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/io/geant4.py +13 -23
  49. essdiffraction-25.6.0/src/ess/dream/workflow.py → essdiffraction-25.9.0/src/ess/dream/workflows.py +106 -50
  50. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/__init__.py +1 -0
  51. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/masking.py +7 -2
  52. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/types.py +0 -7
  53. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/data.py +48 -48
  54. {essdiffraction-25.6.0 → essdiffraction-25.9.0/src/essdiffraction.egg-info}/PKG-INFO +12 -12
  55. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/essdiffraction.egg-info/SOURCES.txt +14 -5
  56. essdiffraction-25.9.0/src/essdiffraction.egg-info/requires.txt +17 -0
  57. essdiffraction-25.9.0/tests/beer/mcstas_reduction_test.py +53 -0
  58. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/dream/geant4_reduction_test.py +21 -22
  59. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/dream/io/geant4_test.py +6 -13
  60. essdiffraction-25.6.0/tests/dream/io/nexus_test.py → essdiffraction-25.9.0/tests/dream/workflows/dream_generic_workflow_test.py +12 -12
  61. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tox.ini +1 -1
  62. essdiffraction-25.6.0/.github/workflows/python-version-ci +0 -1
  63. essdiffraction-25.6.0/.python-version +0 -1
  64. essdiffraction-25.6.0/conda/meta.yaml +0 -57
  65. essdiffraction-25.6.0/docs/api-reference/index.md +0 -71
  66. essdiffraction-25.6.0/docs/bibliography.bib +0 -8
  67. essdiffraction-25.6.0/requirements/basetest.txt +0 -49
  68. essdiffraction-25.6.0/src/ess/dream/io/nexus.py +0 -66
  69. essdiffraction-25.6.0/src/essdiffraction.egg-info/requires.txt +0 -16
  70. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.copier-answers.ess.yml +0 -0
  71. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/ISSUE_TEMPLATE/high-level-requirement.yml +0 -0
  72. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/dependabot.yml +0 -0
  73. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/ci.yml +0 -0
  74. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/docs.yml +0 -0
  75. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/nightly_at_main.yml +0 -0
  76. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/nightly_at_release.yml +0 -0
  77. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/test.yml +0 -0
  78. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/unpinned.yml +0 -0
  79. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.github/workflows/weekly_windows_macos.yml +0 -0
  80. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/.gitignore +0 -0
  81. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/CODE_OF_CONDUCT.md +0 -0
  82. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/CONTRIBUTING.md +0 -0
  83. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/LICENSE +0 -0
  84. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/MANIFEST.in +0 -0
  85. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/anaconda-icon.js +0 -0
  86. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/favicon.svg +0 -0
  87. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/logo-dark.svg +0 -0
  88. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/logo.svg +0 -0
  89. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/thumbnails/dream_advanced_powder_reduction_dark.svg +0 -0
  90. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/thumbnails/dream_advanced_powder_reduction_light.svg +0 -0
  91. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/thumbnails/dream_basic_powder_reduction_dark.svg +0 -0
  92. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_static/thumbnails/dream_basic_powder_reduction_light.svg +0 -0
  93. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_templates/class-template.rst +0 -0
  94. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_templates/doc_version.html +0 -0
  95. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/_templates/module-template.rst +0 -0
  96. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/about/bibliography.rst +0 -0
  97. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/developer/coding-conventions.md +0 -0
  98. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/developer/dependency-management.md +0 -0
  99. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/developer/index.md +0 -0
  100. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/index.md +0 -0
  101. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/common/index.md +0 -0
  102. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/common/vanadium_processing.ipynb +0 -0
  103. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/dream-detector-diagnostics.ipynb +0 -0
  104. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/dream-powder-reduction.ipynb +0 -0
  105. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/dream-visualize-absorption.ipynb +0 -0
  106. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/dream/workflow-widget-dream.ipynb +0 -0
  107. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/sns-instruments/POWGEN_data_reduction.ipynb +0 -0
  108. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/docs/user-guide/sns-instruments/index.md +0 -0
  109. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/ci.in +0 -0
  110. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/dev.in +0 -0
  111. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/make_base.py +0 -0
  112. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/mypy.in +0 -0
  113. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/static.in +0 -0
  114. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/test.in +0 -0
  115. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/requirements/wheels.in +0 -0
  116. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/resources/logo.svg +0 -0
  117. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/setup.cfg +0 -0
  118. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/diffraction/__init__.py +0 -0
  119. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/diffraction/py.typed +0 -0
  120. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/beamline.py +0 -0
  121. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/diagnostics.py +0 -0
  122. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/io/cif.py +0 -0
  123. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/parameters.py +0 -0
  124. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/dream/py.typed +0 -0
  125. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/_util.py +0 -0
  126. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/calibration.py +0 -0
  127. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/conversion.py +0 -0
  128. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/correction.py +0 -0
  129. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/filtering.py +0 -0
  130. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/grouping.py +0 -0
  131. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/logging.py +0 -0
  132. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/py.typed +0 -0
  133. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/smoothing.py +0 -0
  134. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/powder/transform.py +0 -0
  135. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/__init__.py +0 -0
  136. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/beamline.py +0 -0
  137. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/calibration.py +0 -0
  138. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/instrument_view.py +0 -0
  139. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/peaks.py +0 -0
  140. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/ess/snspowder/powgen/workflow.py +0 -0
  141. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/essdiffraction.egg-info/dependency_links.txt +0 -0
  142. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/src/essdiffraction.egg-info/top_level.txt +0 -0
  143. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/conftest.py +0 -0
  144. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/dream/diagnostics_test.py +0 -0
  145. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/dream/instrument_view_test.py +0 -0
  146. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/dream/io/cif_test.py +0 -0
  147. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/package_test.py +0 -0
  148. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/powder/conversion_test.py +0 -0
  149. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/powder/correction_test.py +0 -0
  150. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/powder/filtering_test.py +0 -0
  151. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/powder/transform_test.py +0 -0
  152. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/snspowder/powgen/load_test.py +0 -0
  153. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tests/snspowder/powgen/powgen_reduction_test.py +0 -0
  154. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tools/docs/dream-thumbnails.ipynb +0 -0
  155. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tools/preprocess_pg3_files.ipynb +0 -0
  156. {essdiffraction-25.6.0 → essdiffraction-25.9.0}/tools/shrink_nexus.py +0 -0
@@ -1,9 +1,9 @@
1
1
  # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2
- _commit: 3f79959
2
+ _commit: 024a41b
3
3
  _src_path: gh:scipp/copier_template
4
4
  description: Diffraction data reduction for the European Spallation Source
5
5
  max_python: '3.13'
6
- min_python: '3.10'
6
+ min_python: '3.11'
7
7
  namespace_package: ess
8
8
  nightly_deps: scipp,scippnexus,sciline,plopp,scippneutron,essreduce,tof
9
9
  orgname: scipp
@@ -0,0 +1,37 @@
1
+ name: Nightly test using lower bound dependencies
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ schedule:
6
+ - cron: '30 1 * * 1-5'
7
+
8
+ jobs:
9
+ setup:
10
+ name: Setup variables
11
+ runs-on: 'ubuntu-24.04'
12
+ outputs:
13
+ min_python: ${{ steps.vars.outputs.min_python }}
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - name: Get Python version for other CI jobs
17
+ id: vars
18
+ run: echo "min_python=$(< .github/workflows/python-version-ci)" >> "$GITHUB_OUTPUT"
19
+
20
+ tests:
21
+ name: Tests at lower bound
22
+ needs: setup
23
+ strategy:
24
+ matrix:
25
+ os: ['ubuntu-24.04']
26
+ python:
27
+ - version: '${{needs.setup.outputs.min_python}}'
28
+ runs-on: ${{ matrix.os }}
29
+ env:
30
+ ESS_PROTECTED_FILESTORE_USERNAME: ${{ secrets.ESS_PROTECTED_FILESTORE_USERNAME }}
31
+ ESS_PROTECTED_FILESTORE_PASSWORD: ${{ secrets.ESS_PROTECTED_FILESTORE_PASSWORD }}
32
+ steps:
33
+ - uses: actions/checkout@v4
34
+ - uses: astral-sh/setup-uv@v6
35
+ with:
36
+ python-version: ${{ matrix.python.version }}
37
+ - run: uv run --extra=test --resolution=lowest-direct pytest
@@ -10,29 +10,6 @@ defaults:
10
10
  shell: bash -l {0} # required for conda env
11
11
 
12
12
  jobs:
13
- build_conda:
14
- name: Conda build
15
- runs-on: 'ubuntu-24.04'
16
-
17
- steps:
18
- - uses: actions/checkout@v4
19
- with:
20
- submodules: true
21
- fetch-depth: 0 # history required so setuptools_scm can determine version
22
-
23
- - uses: mamba-org/setup-micromamba@v1
24
- with:
25
- environment-name: build-env
26
- create-args: >-
27
- conda-build
28
- boa
29
- - run: conda mambabuild --channel conda-forge --channel scipp --no-anaconda-upload --override-channels --output-folder conda/package conda
30
-
31
- - uses: actions/upload-artifact@v4
32
- with:
33
- name: conda-package-noarch
34
- path: conda/package/noarch/*.tar.bz2
35
-
36
13
  build_wheels:
37
14
  name: Wheels
38
15
  runs-on: 'ubuntu-24.04'
@@ -60,7 +37,7 @@ jobs:
60
37
 
61
38
  upload_pypi:
62
39
  name: Deploy PyPI
63
- needs: [build_wheels, build_conda]
40
+ needs: [build_wheels]
64
41
  runs-on: 'ubuntu-24.04'
65
42
  environment: release
66
43
  permissions:
@@ -70,25 +47,8 @@ jobs:
70
47
  - uses: actions/download-artifact@v4
71
48
  - uses: pypa/gh-action-pypi-publish@v1.12.4
72
49
 
73
- upload_conda:
74
- name: Deploy Conda
75
- needs: [build_wheels, build_conda]
76
- runs-on: 'ubuntu-24.04'
77
- if: github.event_name == 'release' && github.event.action == 'published'
78
-
79
- steps:
80
- - uses: actions/download-artifact@v4
81
- - uses: mamba-org/setup-micromamba@v1
82
- with:
83
- environment-name: upload-env
84
- # frozen python due to breaking removal of 'imp' in 3.12
85
- create-args: >-
86
- anaconda-client
87
- python=3.11
88
- - run: anaconda --token ${{ secrets.ANACONDATOKEN }} upload --user scipp --label main $(ls conda-package-noarch/*.tar.bz2)
89
-
90
50
  docs:
91
- needs: [upload_conda, upload_pypi]
51
+ needs: [upload_pypi]
92
52
  uses: ./.github/workflows/docs.yml
93
53
  with:
94
54
  publish: ${{ github.event_name == 'release' && github.event.action == 'published' }}
@@ -10,7 +10,6 @@ repos:
10
10
  - id: check-merge-conflict
11
11
  - id: check-toml
12
12
  - id: check-yaml
13
- exclude: conda/meta.yaml
14
13
  - id: detect-private-key
15
14
  - id: trailing-whitespace
16
15
  args: [ --markdown-linebreak-ext=md ]
@@ -0,0 +1 @@
1
+ 3.11
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: essdiffraction
3
- Version: 25.6.0
3
+ Version: 25.9.0
4
4
  Summary: Diffraction data reduction for the European Spallation Source
5
5
  Author: Scipp contributors
6
6
  License-Expression: BSD-3-Clause
@@ -12,35 +12,35 @@ Classifier: Natural Language :: English
12
12
  Classifier: Operating System :: OS Independent
13
13
  Classifier: Programming Language :: Python :: 3
14
14
  Classifier: Programming Language :: Python :: 3 :: Only
15
- Classifier: Programming Language :: Python :: 3.10
16
15
  Classifier: Programming Language :: Python :: 3.11
17
16
  Classifier: Programming Language :: Python :: 3.12
18
17
  Classifier: Programming Language :: Python :: 3.13
19
18
  Classifier: Topic :: Scientific/Engineering
20
19
  Classifier: Typing :: Typed
21
- Requires-Python: >=3.10
20
+ Requires-Python: >=3.11
22
21
  Description-Content-Type: text/markdown
23
22
  License-File: LICENSE
24
- Requires-Dist: dask
25
- Requires-Dist: essreduce>=25.05.3
23
+ Requires-Dist: dask>=2022.1.0
24
+ Requires-Dist: essreduce>=25.07.0
26
25
  Requires-Dist: graphviz
27
- Requires-Dist: numpy
28
- Requires-Dist: plopp>=25.03.0
29
- Requires-Dist: pythreejs
26
+ Requires-Dist: numpy>=1.25
27
+ Requires-Dist: plopp>=25.07.0
28
+ Requires-Dist: pythreejs>=2.4.1
30
29
  Requires-Dist: sciline>=25.04.1
31
30
  Requires-Dist: scipp>=25.05.1
32
31
  Requires-Dist: scippneutron>=25.02.0
33
32
  Requires-Dist: scippnexus>=23.12.0
34
33
  Requires-Dist: tof>=25.01.2
35
34
  Provides-Extra: test
36
- Requires-Dist: pandas; extra == "test"
37
- Requires-Dist: pooch; extra == "test"
38
- Requires-Dist: pytest; extra == "test"
35
+ Requires-Dist: pandas>=2.1.2; extra == "test"
36
+ Requires-Dist: pooch>=1.5; extra == "test"
37
+ Requires-Dist: pytest>=7.0; extra == "test"
38
+ Requires-Dist: ipywidgets>=8.1.7; extra == "test"
39
39
  Dynamic: license-file
40
40
 
41
41
  [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
42
42
  [![PyPI badge](http://img.shields.io/pypi/v/essdiffraction.svg)](https://pypi.python.org/pypi/essdiffraction)
43
- [![Anaconda-Server Badge](https://anaconda.org/scipp/essdiffraction/badges/version.svg)](https://anaconda.org/scipp/essdiffraction)
43
+ [![Anaconda-Server Badge](https://anaconda.org/conda-forge/essdiffraction/badges/version.svg)](https://anaconda.org/conda-forge/essdiffraction)
44
44
  [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
45
45
 
46
46
  # ESSdiffraction
@@ -1,6 +1,6 @@
1
1
  [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
2
2
  [![PyPI badge](http://img.shields.io/pypi/v/essdiffraction.svg)](https://pypi.python.org/pypi/essdiffraction)
3
- [![Anaconda-Server Badge](https://anaconda.org/scipp/essdiffraction/badges/version.svg)](https://anaconda.org/scipp/essdiffraction)
3
+ [![Anaconda-Server Badge](https://anaconda.org/conda-forge/essdiffraction/badges/version.svg)](https://anaconda.org/conda-forge/essdiffraction)
4
4
  [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
5
5
 
6
6
  # ESSdiffraction
@@ -2,11 +2,11 @@
2
2
 
3
3
  ## Development
4
4
 
5
- ESSdiffraction is an open source project by the [European Spallation Source ERIC](https://europeanspallationsource.se/) (ESS).
5
+ ESSdiffraction is an open source project by the [European Spallation Source ERIC](https://ess.eu/) (ESS).
6
6
 
7
7
  ## License
8
8
 
9
- ESSdiffraction is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
9
+ ESSdiffraction is available as open source under the [BSD-3 license](https://opensource.org/license/BSD-3-Clause).
10
10
 
11
11
  ## Citing ESSdiffraction
12
12
 
@@ -0,0 +1,153 @@
1
+ # API Reference
2
+
3
+ ## ESSpowder
4
+
5
+ ### Module Attributes
6
+ ```{eval-rst}
7
+ .. currentmodule:: ess.powder
8
+
9
+ .. autosummary::
10
+ :toctree: ../generated/attributes
11
+
12
+ providers
13
+
14
+ .. autosummary::
15
+ :toctree: ../generated/classes
16
+
17
+ RunNormalization
18
+
19
+ .. autosummary::
20
+ :toctree: ../generated/functions
21
+
22
+ with_pixel_mask_filenames
23
+ ```
24
+
25
+ ### Submodules
26
+
27
+ ```{eval-rst}
28
+ .. autosummary::
29
+ :toctree: ../generated/modules
30
+ :template: module-template.rst
31
+ :recursive:
32
+
33
+ calibration
34
+ conversion
35
+ correction
36
+ filtering
37
+ grouping
38
+ logging
39
+ masking
40
+ smoothing
41
+ transform
42
+ types
43
+ ```
44
+
45
+ ## DREAM
46
+
47
+ ### Workflows
48
+
49
+
50
+ ```{eval-rst}
51
+ .. currentmodule:: ess.dream
52
+
53
+ .. autosummary::
54
+ :toctree: ../generated/functions
55
+
56
+ DreamGeant4MonitorHistogramWorkflow
57
+ DreamGeant4MonitorIntegratedWorkflow
58
+ DreamGeant4ProtonChargeWorkflow
59
+ DreamGeant4Workflow
60
+ DreamPowderWorkflow
61
+ DreamWorkflow
62
+ ```
63
+
64
+ ### Top-level functions
65
+
66
+ ```{eval-rst}
67
+ .. currentmodule:: ess.dream
68
+
69
+ .. autosummary::
70
+ :toctree: ../generated/functions
71
+
72
+ instrument_view
73
+ load_geant4_csv
74
+ ```
75
+
76
+ ### Top-level classes
77
+
78
+ ```{eval-rst}
79
+ .. currentmodule:: ess.dream
80
+
81
+ .. autosummary::
82
+ :toctree: ../generated/classes
83
+
84
+ InstrumentConfiguration
85
+ ```
86
+
87
+ ### Submodules
88
+
89
+ ```{eval-rst}
90
+ .. autosummary::
91
+ :toctree: ../generated/modules
92
+ :template: module-template.rst
93
+ :recursive:
94
+
95
+ beamline
96
+ data
97
+ diagnostics
98
+ io
99
+ ```
100
+
101
+ ## BEER
102
+
103
+ ### Workflows
104
+
105
+
106
+ ```{eval-rst}
107
+ .. currentmodule:: ess.beer
108
+
109
+ .. autosummary::
110
+ :toctree: ../generated/functions
111
+
112
+ BeerModMcStasWorkflowKnownPeaks
113
+ BeerModMcStasWorkflow
114
+ ```
115
+
116
+ ### Top-level functions
117
+
118
+ ```{eval-rst}
119
+ .. currentmodule:: ess.beer
120
+
121
+ .. autosummary::
122
+ :toctree: ../generated/functions
123
+
124
+ load_beer_mcstas
125
+ ```
126
+
127
+ ### Submodules
128
+
129
+ ```{eval-rst}
130
+ .. autosummary::
131
+ :toctree: ../generated/modules
132
+ :template: module-template.rst
133
+ :recursive:
134
+
135
+ clustering
136
+ conversions
137
+ data
138
+ io
139
+ workflow
140
+ ```
141
+
142
+ ## SNS powder
143
+
144
+ ```{eval-rst}
145
+ .. currentmodule:: ess.snspowder
146
+
147
+ .. autosummary::
148
+ :toctree: ../generated/modules
149
+ :template: module-template.rst
150
+ :recursive:
151
+
152
+ powgen
153
+ ```
@@ -0,0 +1,20 @@
1
+ @book{Arblaster:2018,
2
+ author = {John W. Arblaster},
3
+ year = {2018},
4
+ title = {Selected Values of the Crystallographic Properties of the Elements},
5
+ publisher = {ASM International},
6
+ ISBN = {978-1-62708-154-2},
7
+ url = {https://www.asminternational.org/selected-values-of-the-crystallographic-properties-of-the-elements/results/-/journal_content/56/39867022/PUBLICATION/}
8
+ }
9
+ @article{ROUIJAA20187,
10
+ title = {Beam modulation: A novel ToF-technique for high resolution diffraction at the Beamline for European Materials Engineering Research (BEER)},
11
+ journal = {Nuclear Instruments and Methods in Physics Research Section A: Accelerators, Spectrometers, Detectors and Associated Equipment},
12
+ volume = {889},
13
+ pages = {7-15},
14
+ year = {2018},
15
+ issn = {0168-9002},
16
+ doi = {https://doi.org/10.1016/j.nima.2017.12.083},
17
+ author = {M. Rouijaa and R. Kampmann and J. Šaroun and J. Fenske and P. Beran and M. Müller and P. Lukáš and A. Schreyer},
18
+ keywords = {Time-of-flight diffractometer, Strain scanner, Residual stress},
19
+ abstract = {The Beamline for European Materials Engineering Research (BEER) is under construction at the European Spallation Source (ESS) in Lund, Sweden. A basic requirement on BEER is to make best use of the long ESS pulse (2.86 ms) for engineering investigations. High-resolution diffraction, however, demands timing resolution up to 0.1% corresponding to a pulse length down to about 70 μs for the case of thermal neutrons (λ ∼ 1.8 Å). Such timing resolution can be achieved by pulse shaping techniques cutting a short section out of the long pulse, and thus paying for resolution by strong loss of intensity. In contrast to this, BEER proposes a novel operation mode called pulse modulation technique based on a new chopper design, which extracts several short pulses out of the long ESS pulse, and hence leads to a remarkable gain of intensity compared to nowadays existing conventional pulse shaping techniques. The potential of the new technique can be used with full advantage for investigating strains and textures of highly symmetric materials. Due to its instrument design and the high brilliance of the ESS pulse, BEER is expected to become the European flagship for engineering research for strain mapping and texture analysis.}
20
+ }
@@ -21,20 +21,21 @@ author = 'Scipp contributors'
21
21
  html_show_sourcelink = True
22
22
 
23
23
  extensions = [
24
- "sphinx.ext.autodoc",
25
- "sphinx.ext.autosummary",
26
- "sphinx.ext.doctest",
27
- "sphinx.ext.githubpages",
28
- "sphinx.ext.intersphinx",
29
- "sphinx.ext.mathjax",
30
- "sphinx.ext.napoleon",
31
- "sphinx.ext.viewcode",
32
- "sphinx_autodoc_typehints",
33
- "sphinx_copybutton",
34
- "sphinx_design",
35
- "sphinxcontrib.bibtex",
36
- "nbsphinx",
37
- "myst_parser",
24
+ 'sphinx.ext.autodoc',
25
+ 'sphinx.ext.autosummary',
26
+ 'sphinx.ext.doctest',
27
+ 'sphinx.ext.githubpages',
28
+ 'sphinx.ext.intersphinx',
29
+ 'sphinx.ext.mathjax',
30
+ 'sphinx.ext.napoleon',
31
+ 'sphinx.ext.viewcode',
32
+ 'sphinx_autodoc_typehints',
33
+ 'sphinx_copybutton',
34
+ 'sphinx_design',
35
+ 'sphinxcontrib.autodoc_pydantic',
36
+ 'sphinxcontrib.bibtex',
37
+ 'nbsphinx',
38
+ 'myst_parser',
38
39
  ]
39
40
 
40
41
  try:
@@ -69,9 +70,17 @@ autodoc_type_aliases = {
69
70
  }
70
71
 
71
72
  intersphinx_mapping = {
72
- "python": ("https://docs.python.org/3", None),
73
73
  "numpy": ("https://numpy.org/doc/stable/", None),
74
+ "pydantic": ("https://docs.pydantic.dev/latest", None),
75
+ "python": ("https://docs.python.org/3", None),
76
+ # Scipp:
77
+ "essreduce": ("https://scipp.github.io/essreduce", None),
78
+ "plopp": ("https://scipp.github.io/plopp", None),
79
+ "sciline": ("https://scipp.github.io/sciline", None),
74
80
  "scipp": ("https://scipp.github.io/", None),
81
+ "scippneutron": ("https://scipp.github.io/scippneutron", None),
82
+ "scippnexus": ("https://scipp.github.io/scippnexus", None),
83
+ "tof": ("https://scipp.github.io/tof", None),
75
84
  }
76
85
 
77
86
  # autodocs includes everything, even irrelevant API internals. autosummary
@@ -194,7 +203,7 @@ html_theme_options = {
194
203
  },
195
204
  {
196
205
  "name": "Conda",
197
- "url": "https://anaconda.org/scipp/essdiffraction",
206
+ "url": "https://anaconda.org/conda-forge/essdiffraction",
198
207
  "icon": "fa-custom fa-anaconda",
199
208
  "type": "fontawesome",
200
209
  },
@@ -278,7 +287,8 @@ linkcheck_ignore = [
278
287
  "https://www.sciencedirect.com/science/article/pii/S2773183922000374",
279
288
  # Linkcheck seems to be denied access by some DOI resolvers.
280
289
  # Since DOIs are supposed to be permanent, we don't need to check them.'
281
- r'https://doi\.org/',
290
+ r'https?://doi\.org/',
291
+ r'https?://dx\.doi\.org/',
282
292
  ]
283
293
 
284
294
  # -- Options for bibtex ---------------------------------------------------
@@ -40,7 +40,7 @@ Alternatively, if you want a different workflow, take a look at ``tox.ini`` or `
40
40
  Run the tests using
41
41
 
42
42
  ```sh
43
- tox -e py310
43
+ tox -e py311
44
44
  ```
45
45
 
46
46
  (or just `tox` if you want to run all environments).