glotzerlab / glotzerlab/freud-examples
Update Filter examples
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 15
- Forks
- 6
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Description
Currently the SANN filter example has issues with generated environments having incomplete neighbor shells, which can happen when the snapshot is very inhomogeneous.
We should construct an example with care to make the example more reproducible. This will also help the CI pass consistently.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the SANN filter example and inspect how its generated environments produce neighbor shells, then review the CI context in which the example runs. Rework the example setup so the snapshot is reproducible even for inhomogeneous systems, and confirm that CI passes consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100