Skip to content

Python treeppl package install instructions #23

@ronquist

Description

@ronquist

On the Getting Started Page, we ask python users to install treeppl using

`pip install name-of-file.whl``

On a Macintosh with homebrew, this will generate a warning message, saying that you should install the treeppl package in a virtual environment. So we need to give some instructions on how you do that in a good way.

Also, I think it is usually pip3 install and not pip install, which might be unexpected for new Python users. Saying something about this would be good.

Finally, the install directs you to the README for the treeppl-python package, and that README file gives different install instructions. First, those instructions ask you to install treeppl (after giving the command that you should use to install the python package afterwards, which is not so good for users). The link that is given there should probably go (see below), but if it remains it should go to the developer install instructions and not to the Getting Started Page, as is the case currently, which is very confusing.

Then the pip install instruction is different here:
pip install "git+https://github.com/treeppl/treeppl-python#egg=treeppl"

I did not try to use this as I was not able to recompile treeppl (see issue #22 ). But I assume we should change this anyway to rely on the self-contained python package, that is, these install instructions should be the same as those on the Getting Started Page, with some additional info about Jupyter notebooks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions