Add virtual environment documentation #233
Closed
Conversation
This file contains 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
…nv with angelo packages helps
…works with my branch
…to context_spatial
…dd file saving tests to calc_dist_matrix in spatial_analysis_utils_test.py
…to context_spatial
|
Accidentally branched off of context_spatial, restarting. |
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 the purpose of this PR?
Addresses and closes #202. We add documentation for creating virtual environments and installing our package via
pipnow that it has been deployed to PyPI. This will provide a foundation for users with more technical expertise to useark.How did you implement your changes
Content is added to
docs/_rtd/virtualenv.mdto generate documentation on ReadTheDocs about virtual environment creation withcondaandpipinstallation.Remaining issues
This PR may also need to address an issue which prevents all the
install_requirespackages insetup.pyfrom installing on top of runningpip install ark-analysis. We could get around this by simply listing in this page which additional packages need to be installed. What do you guys think?