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

add tutorial test yml #187

Merged
merged 2 commits into from
Jun 17, 2024
Merged

add tutorial test yml #187

merged 2 commits into from
Jun 17, 2024

Conversation

sroet
Copy link
Collaborator

@sroet sroet commented Jun 14, 2024

closes #148

For now this does not include coverage
It uses repo secrets for pulling from dataverse, which means it has to be spawned like the coverage comment workflow

It walks through the tutorial file, grabs all code blocks and executes them if they start with *.py

Copy link

github-actions bot commented Jun 14, 2024

File Coverage Missing
All files 87%
src/pytom_tm/correlation.py 85% 97-98 129
src/pytom_tm/entry_points.py 79% 28 105-122 220-265 354-372 490-507 940-951
src/pytom_tm/extract.py 75% 122-133 193-200 235-240 332-350
src/pytom_tm/io.py 80% 19 40 58 76 88 108-115 131-135 143 150 161 168 214-216 280 316-319 420-428 453
src/pytom_tm/mask.py 80% 72 90 100-101
src/pytom_tm/parallel.py 89% 14-15 89 100-101 107 170
src/pytom_tm/plotting.py 16% 19-21 24-31 35-43 47-50 53-69 72-73 76-77 97-102 118-126 132-149 164-172 176-193 197-205 209-216 222 228 233 247-395
src/pytom_tm/tmjob.py 97% 301-302 318 327-331 398 519 563
src/pytom_tm/utils.py 78% 17-19
src/pytom_tm/weights.py 96% 57 304-307 314 519 524 529

Minimum allowed coverage is 86%

Generated by 🐒 cobertura-action against 49e0701

@sroet sroet marked this pull request as ready for review June 14, 2024 14:57
@sroet sroet requested a review from McHaillet June 14, 2024 14:58
@sroet
Copy link
Collaborator Author

sroet commented Jun 14, 2024

@McHaillet as with #118 this will not work properly before it is actually in the main repo due to the way the protections are set up

Copy link
Collaborator

@McHaillet McHaillet 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. My main concern is that running all the tutorial commands takes some time, a rough guess would be ~40 mins (to give a ballpark). Perhaps we could require the tutorial to run before releasing a new version to pypi.

BTW not specifically requesting to change (should have made this review comment), but just wanted to discuss this point.

@sroet
Copy link
Collaborator Author

sroet commented Jun 17, 2024

BTW not specifically requesting to change (should have made this review comment), but just wanted to discuss this point.

Understandable, we can also just run it on the weekly builds if you want. First wanted just to see if it actually runs (and in what time)

@McHaillet
Copy link
Collaborator

BTW not specifically requesting to change (should have made this review comment), but just wanted to discuss this point.

Understandable, we can also just run it on the weekly builds if you want. First wanted just to see if it actually runs (and in what time)

Alright, that sounds good :)

@sroet sroet merged commit 281fb5a into main Jun 17, 2024
2 checks passed
@sroet sroet deleted the add_tutorial_test branch June 17, 2024 14:18
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.

Test the tutorial
2 participants