search

robotarium / robotarium_python_simulator

A Python simulator for the Robotarium! See your algorithm run on real robots!
MIT License
111 stars 59 forks source link

Separate Install Directions for Users and Developers #6

Open guyfleeman opened 5 years ago

guyfleeman commented 5 years ago

The setup.py and accompanying documentation should probably specify different directions for installation for users and developers. The script currently install deps and the rps module to a system cache. This is pretty confusing when you're working on examples and running them our of the repo, but it's actually sourcing some of the files from a different place. I think most projects use a two-step process: pip install dependencies, and a system install.

At the very least docs should mention more strongly it's installing to the system cache. There should be a way to run the sim without installing it to the system cache.

I'd be happy to help tackle this once we agree on an approach.

pglotfel commented 5 years ago

I feel like it's pretty normal for python installations to contain dependencies for Python projects, hence the options in the setup.py file; moreover, I feel like installing a Python project inherently carries the implication that it will install to the system, but I'm definitely open to discussion on these issues.

The point about running examples also confuses me a little bit. The project needs to be installed in order for the module lookup to work successfully. Have you seen the developer install options?

python developer mode

pglotfel commented 5 years ago

Also, could you provide an example that demonstrates the confusing behavior?