From 7f282bb4ef00af59a88d4308d6f90b2aa15133d7 Mon Sep 17 00:00:00 2001 From: Johannes Kasimir Date: Fri, 11 Apr 2025 12:15:29 +0200 Subject: [PATCH 1/2] copier update --- .copier-answers.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/release.yml | 2 +- .gitignore | 1 + docs/index.md | 36 +++++++++++++++++++++++++++++++-- docs/user-guide/index.md | 3 ++- docs/user-guide/installation.md | 16 +++++++++++++++ tox.ini | 2 ++ 8 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 docs/user-guide/installation.md diff --git a/.copier-answers.yml b/.copier-answers.yml index 1ddfc49a..20883544 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY -_commit: d704227 +_commit: d3d4dc7 _src_path: gh:scipp/copier_template description: Reflectometry data reduction for the European Spallation Source max_python: '3.13' diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 69491d17..47294b92 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -71,7 +71,7 @@ jobs: path: html/ - run: echo "::notice::https://remote-unzip.deno.dev/${{ github.repository }}/artifacts/${{ steps.artifact-upload-step.outputs.artifact-id }}" - - uses: JamesIves/github-pages-deploy-action@v4.7.2 + - uses: JamesIves/github-pages-deploy-action@v4.7.3 if: ${{ inputs.publish }} with: branch: gh-pages diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index fe8ef23d..f88b3447 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -68,7 +68,7 @@ jobs: if: github.event_name == 'release' && github.event.action == 'published' steps: - uses: actions/download-artifact@v4 - - uses: pypa/gh-action-pypi-publish@v1.8.14 + - uses: pypa/gh-action-pypi-publish@v1.12.4 upload_conda: name: Deploy Conda diff --git a/.gitignore b/.gitignore index 340e6499..720318ba 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,7 @@ venv .venv # Caches +*.DS_Store .clangd/ *.ipynb_checkpoints __pycache__/ diff --git a/docs/index.md b/docs/index.md index 388eb771..5b26ac3c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,29 @@ -# ESSreflectometry +:::{image} _static/logo.svg +:class: only-light +:alt: ESSreflectometry +:width: 60% +:align: center +::: +:::{image} _static/logo-dark.svg +:class: only-dark +:alt: ESSreflectometry +:width: 60% +:align: center +::: - +```{raw} html + +``` + +```{role} transparent +``` + +# {transparent}`ESSreflectometry` + + Reflectometry data reduction for the European Spallation Source

@@ -22,3 +45,12 @@ api-reference/index developer/index about/index ``` + +:::{include} user-guide/installation.md +:heading-offset: 1 +::: + +## Get in touch + +- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/essreflectometry/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/essreflectometry). diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md index 1ddd66e2..993e2925 100644 --- a/docs/user-guide/index.md +++ b/docs/user-guide/index.md @@ -1,9 +1,10 @@ -# User guide +# User Guide ```{toctree} --- maxdepth: 1 --- +installation amor/index estia/index ``` diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md new file mode 100644 index 00000000..250cb339 --- /dev/null +++ b/docs/user-guide/installation.md @@ -0,0 +1,16 @@ +# Installation + +To install ESSreflectometry and all of its dependencies, use + +`````{tab-set} +````{tab-item} pip +```sh +pip install essreflectometry +``` +```` +````{tab-item} conda +```sh +conda install -c conda-forge -c scipp essreflectometry +``` +```` +````` diff --git a/tox.ini b/tox.ini index ac012bd6..a30118d0 100644 --- a/tox.ini +++ b/tox.ini @@ -64,6 +64,8 @@ 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 plopp,sciline,scippneutron,scippnexus,scipp From a223c8cb728904c961ae27b88133527bda7f13a8 Mon Sep 17 00:00:00 2001 From: Johannes Kasimir Date: Fri, 11 Apr 2025 13:17:29 +0200 Subject: [PATCH 2/2] copier update -a .copier-answers.ess.yml --- .copier-answers.ess.yml | 2 +- .github/ISSUE_TEMPLATE/blank.md | 8 -------- 2 files changed, 1 insertion(+), 9 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/blank.md diff --git a/.copier-answers.ess.yml b/.copier-answers.ess.yml index 1ab77e63..dcad7e5f 100644 --- a/.copier-answers.ess.yml +++ b/.copier-answers.ess.yml @@ -1,3 +1,3 @@ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY -_commit: 0951a4b +_commit: d1d5caa _src_path: https://github.com/scipp/ess_template.git diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md deleted file mode 100644 index 22a75aeb..00000000 --- a/.github/ISSUE_TEMPLATE/blank.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Blank -about: General issue that does not fit another category -title: '' -labels: '' -assignees: '' - ----