Skip to content
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.

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

Split "full PREP example" into two: 1) show how to use, 2) show validation against matlab #15

Open
sappelhoff opened this issue Apr 4, 2020 · 1 comment

Comments

@sappelhoff
Copy link
Owner

Currently the full PREP example does both, showing how it can be used, and validating the results against the Matlab results.

https://pyprep.readthedocs.io/en/latest/auto_examples/index.html

I think we should rather have two examples:

  • one example where PREP usage is shown more extensively and with more explanations than currently
  • and another example with a focus on validation against the Matlab results (here, the plotting code should be improved, because currently it's very messy to read and probably lots of unneeded code duplication)
@sappelhoff sappelhoff added this to the 0.4.0 milestone Jun 23, 2021
@sappelhoff sappelhoff changed the title full PREP example should be split Split "full PREP example" into two: 1) show how to use, 2) show validation against matlab Jun 23, 2021
@sappelhoff sappelhoff mentioned this issue Aug 2, 2021
@sappelhoff sappelhoff modified the milestones: 0.4.0, 0.5.0 Oct 22, 2021
@sappelhoff
Copy link
Owner Author

Note that regarding the validation part of the example, we should also rely on @a-hurst's https://github.com/a-hurst/matprep_artifacts/tree/master

instead of the old saved data. As for some reason, things have become out of sync and it looks terrible now: https://pyprep.readthedocs.io/en/latest/auto_examples/run_full_prep.html#sphx-glr-auto-examples-run-full-prep-py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant