API: Raise ValueError when ptycho input shapes are wrong - Githubissues

AdvancedPhotonSource / tike

Repository for ptychography software

http://tike.readthedocs.io

Other

29 stars 15 forks source link

API: Raise ValueError when ptycho input shapes are wrong #194

Closed carterbox closed 2 years ago

carterbox commented 2 years ago

Purpose

Provide helpful feedback to programmers learning to use the tike.ptycho.reconstruct API.

Approach

Check (in earnest) all the main inputs of tike.ptycho.reconstruct for correct shapes and other geometric constraints.

Pre-Merge Checklists

Submitter

[x] Write a helpfully descriptive pull request title.
[x] Organize changes into logically grouped commits with descriptive commit messages.
[x] Document all new functions.
[x] Click 'details' on the readthedocs check to view the updated docs.
[x] Write tests for new functions or explain why they are not needed.
[x] Address any complaints from pep8speaks.

Reviewer

[ ] Actually read all of the code.
[ ] Run the new code yourself; the included tests should make this easy.
[ ] Write a summary of the changes as you understand them.
[ ] Thank the submitter.

carterbox commented 2 years ago

Not gonna write tests to try out incorrect inputs. That's fair, right?