NSLS2 / NSLS2/pyCHX

[v2][_commonspeckle] SAXS.py not strictly for XPCS or speckles

Open
#41 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

_commonspeckle discussion Q-space V2
Dominant language
Jupyter Notebook
Stars
8
Forks
12
Avg merge
2h 53m
Merged PRs (30d)
6

Description

This is for static SAXS analysis as noted by module author. Seems good to keep this in common, but if we stick it in an XPCS repo, I am not sure that it would be under utilized.

Also @danielballan mentioned something about a common scattering repo in previous meetings so I am also asking in this context. We could decide on a two-phase plan regarding this.

  1 """
  2 Sep 10 Developed by Y.G.@CHX 
  3 yuzhang@bnl.gov
  4 This module is for the static SAXS analysis, such as fit form factor
  5 """

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing SAXS.py and its module docstring, which describes static SAXS analysis. Resolve whether it should remain in pyCHX/common or move to a common scattering repository, and document the agreed two-phase plan and final location.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.