Skip to content

[ESSREDUCE] Move esspolarization to essreduce #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jokasimr wants to merge 4 commits into from
Closed

[ESSREDUCE] Move esspolarization to essreduce #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dce6834
refactor: move polarization to essreduce
jokasimr Apr 17, 2026
7a5b148
docs: add polarization to docs
jokasimr Apr 17, 2026
b81e691
fixup
jokasimr Apr 17, 2026
dea2f0e
docs: copy docs
jokasimr Apr 17, 2026
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
1 change: 1 addition & 0 deletions packages/essreduce/docs/api-reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
logging
Copy link
Copy Markdown
Member

@nvaytet nvaytet Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you are missing the docs contents of esspolarization? e.g. https://scipp.github.io/esspolarization/user-guide/sans-polarization-analysis-methodology.html

That said, I don't know how much of it we want to keep, but I would say at least to start we would want to keep all of it?

Copy link
Copy Markdown
Contributor Author

@jokasimr jokasimr Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's true, I forgot to move that 👍

nexus
normalization
polarization
streaming
time_of_flight
ui
Expand Down
1 change: 1 addition & 0 deletions packages/essreduce/docs/user-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ maxdepth: 2
---

installation
polarization/index
unwrap/index
widget
reduction-workflow-guidelines
Expand Down
37 changes: 37 additions & 0 deletions packages/essreduce/docs/user-guide/polarization/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# User Guide

## Overview

```{mermaid}
graph TD
A[Sample Run] --> B([SANS Workflow])
B --> C["I(Qx, Qy) in event mode"]
D[Runs with He3 cell at a few time points] --> E([SANS Workflow])
E --> F[wavelength-dependent He3 cell transmission fraction at a few time points]
F --> G([<font color=black>He3 Cell Workflow])
G --> H[<font color=black>time- and wavelength-dependent transmission function]
C --> I([Polarization Correction])
H --> I
I --> J["Corrected I(Qx, Qy) in 4 spin channels"]

style B fill:green
style D fill:green
style E fill:green
style F fill:green
style G fill:yellowgreen
style H fill:yellowgreen
```

## Content

```{toctree}
---
maxdepth: 1
---

workflow
sans-polarization-analysis-methodology
inverse_of_polarization_matrices
zoom
installation
```
16 changes: 16 additions & 0 deletions packages/essreduce/docs/user-guide/polarization/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Installation

To install ESSpolarization and all of its dependencies, use

`````{tab-set}
````{tab-item} pip
```sh
pip install esspolarization
```
````
````{tab-item} conda
```sh
conda install -c conda-forge esspolarization
```
````
`````
Loading
Loading