Fix conda environment and simplify installation and setup through git submodule#25
Open
richardstoeckl wants to merge 4 commits into
Open
Fix conda environment and simplify installation and setup through git submodule#25richardstoeckl wants to merge 4 commits into
richardstoeckl wants to merge 4 commits into
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
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.
Hello, I hope you are doing well.
this PR does two things regarding the installation and setup process, therefore I didn't want to separate them into two PRs.
1. Fix and simplify the conda environment
Some dependencies and packages are not available in their specified version through the
conda-forgeorbiocondachannels anymore (i.e.tensorflow). While some would still available through theanacondachannel, this has some restrictive licensing terms (see the Anaconda Terms of Service). Also, the environment file specified several channels that are either unnecessary (axfeh) or outdated (biobuilds).Changes:
tensorflow,tensorboard, andkerasto pip installation, keeping the same versions.perl-compress-bgzfmodule build.axfeh::spacerplacer(leftover from another project). If it is still needed, thebioconda::spacerplacerpackage should be used instead.2. Automate
CRISPRcasIdentifiersetupCRISPRidentifypreviously required users to manually download and placeCRISPRcasIdentifier v1.1.0in the correct directory. Additionally, models had to be downloaded from Google Drive and placed in the correct location manually. This PR automates this process by addingCRISPRcasIdentifieras a git submodule, and usinggdownto download the correct models. The manual process remains possible without changes.Changes:
BackofenLab/CRISPRcasIdentifieras a git submodule pinned tov1.1.0. Withgit clone --recurse-submodules, the repository is now included automatically in the expected location.gdownas a dependency and includesREADME.mdcommands to download the required models into the correct paths, following the procedure documented inBackofenLab/CRISPRcasIdentifier.I cloned
CRISPRidentifyfresh with--recurse-submodulesand followed the instructions usinggdownfor the model files. I then rebuilt the environment from scratch and confirmed thatpython CRISPRidentify.py --input_folder TestInputruns end-to-end.I am open to feedback, and hope to see you soon again at another conference.
Best,
Richard