Add requirements.txt and update README with dependency installation i… #40
Conversation
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
|
|
AbigaleD
force-pushed
the
add-requirements
branch
from
3506e3b to
67a13a0
Compare
|
@SahandFarhoodi Are these the correct deps? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What is done?
This PR adds a
requirements.txtfile that lists part of Python dependencies required to run this project.Additionally, it updates the
README.mdwith a quick installation guide to make onboarding easier for new contributors and users.Motivation
Currently, trying to run the project with missing packages. Having an explicit
requirements.txthelps prevent this and improves developer experience.Add more packages
If possible, it would also be helpful to include a sample conda or Python environment (e.g.
conda env exportorpip freeze) so contributors can easily reproduce the development setup. I'd be happy to help clean it up or maintain it.