Skip to content

replacing the example / recipes with a tutorial page and improvements#148

Merged
SimoneMartino98 merged 37 commits intoGMPavanLab:mainfrom
SimoneMartino98:recipe_revisions
Jan 27, 2026
Merged

replacing the example / recipes with a tutorial page and improvements#148
SimoneMartino98 merged 37 commits intoGMPavanLab:mainfrom
SimoneMartino98:recipe_revisions

Conversation

@SimoneMartino98
Copy link
Collaborator

hi all;
Just revising the example creating step by step tutorial (GROMACS style)

not finish yet but at least you can have a look.

PS -> there is the possbility to find some "flying" files here and there; don't worry i will clean everything.

Copy link
Collaborator

@andrewtarzia andrewtarzia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking very good!

SimoneMartino98 and others added 12 commits January 23, 2026 09:45
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Co-authored-by: Andrew Tarzia <andrew.tarzia@gmail.com>
Copy link
Collaborator

@matteobecchi matteobecchi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Definitely better organized than before.

Now the ``trj`` variable contains the trajectory, and using the methods of the
:class:`.trajectory.Trj` class we can perform all the dynsight analyses on
this trajectory. For instance, let's say we want to compute the LENS
descriptor (`published paper <https://doi.org/10.1073/pnas.2300565120>`__).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since in the nex tutorial TimeSOAP is cited as Caruso et al., here it is better to cite lens as "Crippa et al." and not as "published paper"

@SimoneMartino98 SimoneMartino98 marked this pull request as ready for review January 26, 2026 14:16
Copy link
Collaborator

@ChiaraLionello ChiaraLionello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think now they are very clear and I like how they are organized. Good job!

Copy link
Collaborator

@andrewtarzia andrewtarzia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Some comments still to do, and we discussed using doctests in the examples still.

examples/info_gain/trj_*.npy
tests/systems/coex/.*
tests/systems/.*
.DS_Store
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just delete these off your computer?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's macOS; every mac user will have this annoying and useless DS_Store. I would ignore it.

If it's a problem, i'll remove that line

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like things you can just delete, but all good.

@SimoneMartino98 SimoneMartino98 merged commit 71c8e59 into GMPavanLab:main Jan 27, 2026
11 checks passed
@SimoneMartino98 SimoneMartino98 deleted the recipe_revisions branch January 28, 2026 10:45
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.

4 participants