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

update readme to point to pip install instead of source #139

Merged
merged 4 commits into from
Mar 1, 2024

Conversation

sroet
Copy link
Collaborator

@sroet sroet commented Mar 1, 2024

Now that the pip install commands are working, we should update our installation instructions as well

@sroet sroet requested a review from McHaillet March 1, 2024 13:44
Copy link

github-actions bot commented Mar 1, 2024

File Coverage Missing
All files 80%
src/pytom_tm/angles.py 94% 44
src/pytom_tm/correlation.py 85% 94-95 126
src/pytom_tm/entry_points.py 68% 27 104-121 283-342 431-445 542-557 791-858 899-910
src/pytom_tm/extract.py 73% 107-118 170-176 202-205 277-295
src/pytom_tm/io.py 42% 14-18 24-27 33-36 42-45 51-54 61-65 73-86 92-99 106-113 128-130 163 197-198 243-245 261 277 294-303 323-328
src/pytom_tm/mask.py 80% 70 85 94-95
src/pytom_tm/matching.py 95% 186-196 340
src/pytom_tm/parallel.py 84% 14-15 81-87 95-97 104 109 148
src/pytom_tm/plotting.py 16% 20-22 25-32 36-44 48-51 54-70 73-74 77-78 98-103 119-127 133-150 165-173 177-194 198-206 210-217 223 229 234 248-398
src/pytom_tm/template.py 57% 57-58 67 76-87 92-97 107-112 114
src/pytom_tm/tmjob.py 96% 170-171 183 189-191 194 327 367
src/pytom_tm/utils.py 78% 16-18
src/pytom_tm/weights.py 95% 59 290-291 298 477 480 483

Minimum allowed coverage is 79%

Generated by 🐒 cobertura-action against 7bb4399

updated the readme some more with the help of the github interface
@sroet sroet marked this pull request as ready for review March 1, 2024 13:47
@sroet
Copy link
Collaborator Author

sroet commented Mar 1, 2024

The tests fail with the same issue that #138 tries to fix, so this shouldprobably be merged after that one

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.

Installation part is good!

For the cupy errors, some suggested changes and I also think this part,

To solve cupy installation issues, please check the cupy docs. It might be solved by installing a specific build compatible with the installed cuda toolkit.

, could be changed to first trying to install with the conda cuda-toolkit and cupy option. And if that doesnt work looking at the cupy docs.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Marten Chaillet <58044494+McHaillet@users.noreply.github.com>
@sroet
Copy link
Collaborator Author

sroet commented Mar 1, 2024

@McHaillet, one of your suggestions isn't accurate with the current code behavior. I have implemented the others

@sroet sroet requested a review from McHaillet March 1, 2024 15:25
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.

LGTM!

@sroet sroet merged commit 924a20d into SBC-Utrecht:main Mar 1, 2024
2 checks passed
@sroet sroet deleted the update_install_instructions branch March 1, 2024 15:43
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

2 participants