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.

Sign up for GitHub

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

Jump to bottom

Write basic usage examples #27

Open
JLBegin opened this issue Jul 26, 2021 · 0 comments
Open

Write basic usage examples #27

JLBegin opened this issue Jul 26, 2021 · 0 comments
Assignees
@JLBegin @shadimasoumi @mirequem
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@JLBegin
Copy link
Contributor

JLBegin commented Jul 26, 2021 •
edited
Loading

We need examples for basic polarization calculations.

There are some in the README (maybe deprecated), but we need them to be in seperate python files, inside an 'examples' directory.
The current file name examples.py is deprecated.

These usage examples will help to spot missing features.

Later we will also write more involved examples targetting OCT, dMRI, and other stuff.
@JLBegin JLBegin added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JLBegin JLBegin

@shadimasoumi shadimasoumi

@mirequem mirequem

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JLBegin @shadimasoumi @mirequem