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
2 changes: 1 addition & 1 deletion .copier-answers.ess.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -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'
Expand Down
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/blank.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ venv
.venv

# Caches
*.DS_Store
.clangd/
*.ipynb_checkpoints
__pycache__/
Expand Down
36 changes: 34 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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
:::

<span style="font-size:1.2em;font-style:italic;color:#5a5a5a">
```{raw} html
<style>
.transparent {display: none; visibility: hidden;}
.transparent + a.headerlink {display: none; visibility: hidden;}
</style>
```

```{role} transparent
```

# {transparent}`ESSreflectometry`

<span style="font-size:1.2em;font-style:italic;color:var(--pst-color-text-muted)">
Reflectometry data reduction for the European Spallation Source
</br></br>
</span>
Expand All @@ -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).
3 changes: 2 additions & 1 deletion docs/user-guide/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# User guide
# User Guide

```{toctree}
---
maxdepth: 1
---
installation
amor/index
estia/index
```
16 changes: 16 additions & 0 deletions docs/user-guide/installation.md
Original file line number Diff line number Diff line change
@@ -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
```
````
`````
2 changes: 2 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading