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

Clarify install instructions for ML processors that are NOT python packages #71

Open
tjd2002 opened this issue Sep 19, 2018 · 2 comments
Assignees
Labels
docs Documentation

Comments

@tjd2002
Copy link
Collaborator

tjd2002 commented Sep 19, 2018

In several places the install instructions for ML processor packages presume that these are well-formed python packages (1) git clone; (2)pip install; (3)ml-link-python-module).

This led to confusion in our lab, when users tried to use the ml-link-python-module command to link a ML processor package (which was just a folder containing python scripts, not a proper python package). Instead, they needed to manually create symlinks from the processor package search path to their ML processor package directories, but this step is not documented.

@tjd2002
Copy link
Collaborator Author

tjd2002 commented Sep 19, 2018

cc @mari-sosa

@tjd2002 tjd2002 changed the title Clarify install instructions for processor packages that are NOT python packages Clarify install instructions for ML processors that are NOT python packages Sep 20, 2018
@magland
Copy link
Collaborator

magland commented Sep 20, 2018

I think the developer installation instructions are technically correct as they stand: https://github.com/flatironinstitute/mountainsort_examples

Note the step: export PYTHONPATH=[fill-in-path]/ml_ms4alg:$PYTHONPATH

After doing that, ml-link-python-module should work, and does the same thing as manually creating the symbolic link.

However, I agree this is confusing. Should we change these docs to a ln -s ... command? Or are there other places where this should be clarified? @tjd2002

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

No branches or pull requests

2 participants