Installing from source via pip

Open Beginner friendly
#326 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Open the installation guide at https://alleninstitute.github.io/bmtk/installation.html and find the section describing installation from source. Update the documented python setup.py install step to show the proposed local pip3 install --prefix=<path/to/software/folder> . command, then verify the guide clearly explains the trailing dot and the resulting installation.

Written by the indexing model from the issue text.

Description

I would like to propose an update to your installation guide (https://alleninstitute.github.io/bmtk/installation.html) when building from source. Currently, the proposed installation step is python setup.py install. However, in the latest versions of Python, using .egg files is deprecated. When I try this on our HPC clusters, I ended up with only .egg files under the lib folder, and not a working copy of the actual bmtk module and its other dependencies.

Instead, simply using pip(3) comes to the rescue, e.g.

cd bmtk-1.0.8     # i.e. the top folder for a specific version
pip3 install --prefix=<path/to/software/folder> .

mind the ending dot . which enforces pip3 to use the local setup.py file.

I hope this helps.

Dominant language
Python
Stars
335
Forks
102
Avg merge
1d 5h
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AllenInstitute/bmtk

All issues in AllenInstitute/bmtk

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.