Add installation instructions in README#54
Merged
Conversation
niksirbi
force-pushed
the
add-install-instructions
branch
from
May 26, 2026 17:11
363d647 to
7af491f
Compare
niksirbi
marked this pull request as ready for review
May 26, 2026 17:15
Co-authored-by: sfmig <33267254+sfmig@users.noreply.github.com>
Member
Author
|
Thanks @sfmig! Good call about explicitly specifying the branch. I've added that and will merge as soon as CI passes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
What is this PR
Why is this PR needed?
I realised we don't have any sort of installation instructions. This was mostly fine, since the package is not yet on PyPI and probably has no users other than us, but that's about to change. We're planning to share this repo with collaborators soon, who will try to use it to contribute data.
What does this PR do?
uvand installing the package directly from GitHubIt DOES NOT add an installation guide to the docs; That will follow after we publish the package on PyPI.
References
N/A
How has this PR been tested?
I reproduced the installation steps locally.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
N/A
Checklist: