py4dstem / py4dstem/py4DSTEM

v15 strain refactor

Open
#623 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

v15
Dominant language
Python
Stars
279
Forks
177
PR merge metrics
No merged PRs in 30d

Description

  • prepare & share test dataset
  • set up tests to confirm correct calibration & rotation behaviors
  • refactor source code
  • refactor demo .ipynb

Contributor guide

No contributing guide indexed for this repository

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 locating the v15 strain source code, existing calibration and rotation tests, the test-data fixtures, and the demo .ipynb referenced in the checklist. Read the current implementation and run the relevant tests first. Done means a shared dataset exists, calibration and rotation behavior is covered, the source and notebook are refactored, and the tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.