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

Elaborate on IgBlast and ChangeO installation in docs #35

Open
BrandenOlson opened this issue Apr 28, 2019 · 1 comment
Open

Elaborate on IgBlast and ChangeO installation in docs #35

BrandenOlson opened this issue Apr 28, 2019 · 1 comment

Comments

@BrandenOlson
Copy link
Collaborator

It might not be obvious to the typical user where Change-O puts its scripts (i.e., ~/.local/bin), and sumrep makes use of a CHANGEO_DIR environment variable to run these scripts. Further, using ChangeO scripts to build the IgBlast libraries may entail cloning the repository, and building IgBlast libraries with some input/output names different from ChangeO docs will lead to issues for sumrep (e.g. in finding the germline directory). We should elaborate on this further in the docs to facilitate this installation process.

@javh
Copy link
Contributor

javh commented Apr 29, 2019

Change-O installs scripts via the scripts argument to setuptools.setup(). When you specify the --user argument to pip, this means they end up in $PYTHONUSERBASE/bin. I don't know why it was decided to default this to ~/.local on linux and Mac OS (I always change it). See PEP370 for OS specific location details.

I'm guessing it'd be cleaner to check the PATH first (if you didn't pass --user to pip, then it'll install into the system location), then fall back to PYTHONUSERBASE/bin to automatically set CHANGEO_DIR.

Though, my feeling is that this is more of a normal python issue, rather than something sumrep needs to address. So, properly documentation is probably sufficient.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants