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

installation instructions can be improved for non-python users #205

Open
necozay opened this issue Oct 1, 2018 · 1 comment
Open

installation instructions can be improved for non-python users #205

necozay opened this issue Oct 1, 2018 · 1 comment
Assignees

Comments

@necozay
Copy link
Contributor

necozay commented Oct 1, 2018

I tried doing a TuLiP installation from scratch on a wiped out Mac. I found the following poitns a bit confusing in installation instructions (this could be because of the strange access rights on Mac).

  • User access rights are not clear in installation instructions. Is it assumed that everything is done in sudo? We might want to clarify this.
  • I started getting pip and installed it for --user.
  • pip install tulip did not work after getting pip as setuptools clashes with the one that comes with Mac python distribution.
  • My attempt to upgrade setuptools with pip also failed due to an EnvironmentError
  • I finally installed virtualenv and installed tulip in a virtualenv with pip
  • Then, I kept reading the instructions in https://pypi.org/project/tulip/. To check the dependencies, it says I should call tulip.interfaces.print_env() but it is not clear where I should call this. Maybe we should mention that this can be called from within python.
  • It also says "A test suite is provided under tests/." but if I use pip for installation, does this folder exist? Maybe we should say, this is for when one installs from the source.

Some of the above points are clearer in the user documentation https://tulip-control.sourceforge.io/doc/install.html where a distinction between PyPi and installing from source is made. Just thought I would write these down in case it is useful for someone else.

@slivingston slivingston self-assigned this Oct 5, 2018
@slivingston
Copy link
Member

while treating this issue, consider switching to Pipenv

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