-
Notifications
You must be signed in to change notification settings - Fork 154
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
Rework Ubuntu Installation Instructions #99
base: main
Are you sure you want to change the base?
Conversation
Bengt
commented
Apr 18, 2023
- Be explicit about Ubuntu version numbers
- Clone repository first to keep the venv local
- Be explicit about Python version numbers
- Prefer using apt instead of apt-get
- Add --yes flag to apt install subcommand
- Use a virtual environment to not pollute the system
- Install python packages in one command so that pip can resolve their dependencies properly
- Use python executables from virtual environment for running analyse.py script
- Be explicit about Ubuntu version numbers - Clone repository first to keep the venv local - Be explicit about Python version numbers - Prefer using apt instead of apt-get - Add --yes flag to apt install subcommand - Use a virtual environment to not pollute the system - Install python packages in one command so that pip can resolve their dependencies properly - Use python executables from virtual environment for running analyse.py script
Add Nvidia LibCUDNN package to virtual environment for a roughtly 3x speedup
Thanks. To be honest, I personally don't like to put virtual environments in the readme, because it complicates things and doesn't look as clean as without. I understand the motivation, I just don't like it as brief overview of the packages we use. I agree with putting everything in one line and cloning first though. I'd like to have a discussion about virtual environments in the readme to get to know peoples opinions. |
In my opinion, the Pros outweigh the Cons. |
@kahst thanks for picking some of my ideas up for inclusion in the main branch. Virtual Environments@kahst could please elaborate on your preference to not virtual environments into readmes? I noticed that there are commands for creating conda environments in the readme. While I agree that these are not technically virtual environments, their commands are more verbose, and they do not solve any additional problems. Are you okay with these? What is your opinion/policy here? Consider:
vs.
Clean ReadmeI suppose, the cleanest readme would only list a
I mean, that is certainly doable and arguable also readable to users that are familiar with venv. However, as @fegue pointed out, many users are not that well versed in setting up virtual environments. I would argue that making users aware of the benefis of virtual environments and expecting them to get familiar with the accompanying tools is out of scope for this readme. Instead, the focus should lay on setting up this project to use it in an application or develop this project further. Therefore, I think that the readme should rather to give a recommendation on using a virtual environment and show how to set up and use one, without any discussion. Yes, there alternatives to using venv like conda, which is already mentioned in other sections of the readme. However, discussing their pros and cons is clearly out of scope for this readme. Moreso, one could even drop the recommendation and just assume that everyone will be using venv. That might seem arrogant, but it makes the readme more concise and is based on the recommendation of the Python project:
|
The conda part is on me because apple needs some dependencies from their channel
|
If you're using conda, you should consider recommending the C++ implementation |
Sounds to me that it's time to start a wiki. Let me know, I can put this together |