alchemistry / alchemlyb

the simple alchemistry library
https://alchemlyb.readthedocs.io
BSD 3-Clause "New" or "Revised" License
191 stars 49 forks source link

Add a tutorial section #379

Closed xiki-tempula closed 1 month ago

xiki-tempula commented 1 month ago

Fix #382

See https://github.com/openjournals/joss-reviews/issues/6934 :

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.83%. Comparing base (f40b89b) to head (7031577).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #379 +/- ## ======================================= Coverage 98.83% 98.83% ======================================= Files 28 28 Lines 1895 1895 Branches 407 407 ======================================= Hits 1873 1873 Misses 2 2 Partials 20 20 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

orbeckst commented 1 month ago

@ryankzhu would you like to review the added tutorial?

The built docs are at https://alchemlyb--379.org.readthedocs.build/en/379/tutorial.html

orbeckst commented 1 month ago

@xiki-tempula let's wait with merging for at least 2 days to give our JOSS reviewers a chance to look at it and ask for changes.

ryankzhu commented 1 month ago

Thank you for adding the tutorial section to the docs! The tutorial looks good to me.