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

PiDMD Tutorial #417

Merged
merged 5 commits into from
Jul 12, 2023
Merged

PiDMD Tutorial #417

merged 5 commits into from
Jul 12, 2023

Conversation

sichinaga
Copy link
Contributor

@sichinaga sichinaga commented Jun 30, 2023

Hi everyone!

Apologies that this took some time, but I've created a lengthy tutorial for the PiDMD module. It basically walks users through a brief overview of the theory of PiDMD and skims through all of the module's available manifolds. It also includes a brief comparison of DMD and PiDMD when applied to a toy dataset.

Currently, this PR only includes the Jupyter Notebook, but I will add the corresponding .py file once we feel this tutorial is good to go! 😄

Edit: I've added the .py file thinking it might help me pass some tests, but maybe not? If someone could fill me in on how to get the tests passing, that would be much appreciated. :)

@mtezzele
Copy link
Contributor

mtezzele commented Jul 7, 2023

@sichinaga I think this is a great tutorial! Thanks for the contribution.
Just add it to the readme table in the tutorials folder, please.

@fandreuz
Copy link
Contributor

fandreuz commented Jul 9, 2023

Hi @sichinaga, we can rely on the GitHub action to automatically generate the .py file based on your notebook after we merge this this, so there's no need to attach it to the PR. The tutorial looks very good!

@ndem0
Copy link
Member

ndem0 commented Jul 10, 2023

Very nice, green light also for me!
Thanks!

@sichinaga
Copy link
Contributor Author

Thank you all for reviewing the tutorial! I removed the .py file so that GitHub can automatically generate it, and I added the tutorial to the readme as per your suggestions. Let me know if anything else needs fixing! :)

@mtezzele mtezzele merged commit d90be4f into PyDMD:master Jul 12, 2023
19 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants