Updated resources.md with detailed local install instructions #15
Conversation
There was a problem hiding this comment.
Thank you so very much for putting this together @t-redactyl <3 I've left a few comments but overall it is truly great!
|
|
||
| To create a virtual environment, open a terminal window and navigate to the directory containing the repo with the Humble Data materials that you just cloned. Do this using the `cd` command we used in the last section when we cloned the repo - see if you can work out how to apply this to getting inside the folder containing the workshop materials! | ||
|
|
||
| Once you're inside this directory, type `python3 -m venv myvenv` at the terminal prompt. This is going to create a new folder inside the directory called "myvenv". This contains a bunch of code to make the virtual environment work. To use the virtual environment, we need to run a piece of this code, which will activate the virtual environment. At the terminal prompt, type: |
There was a problem hiding this comment.
Should we say that myenv can also have any other name they wanna use?
There was a problem hiding this comment.
Yes, that's a great idea!
|
|
||
| Activating the virtual environment allows us to go "inside" of it and install and use whatever packages we like, isolated from the rest of the system. You'll know it worked if the name of the virtual environment appears in parentheses somewhere in your terminal prompt (e.g., `(myvenv) PS C:\path\to\your\project>`). | ||
|
|
||
| To finish, we can install the packages we need to run the workshop materials. The packages we will need are: |
There was a problem hiding this comment.
Should we maybe add the command to install all libraries inside the requirements.txt here?
pip install -r requirements.txt on UNIX systems (using pip).
We have now instructions on how to do it using uv on the readme.md of the workshop as well.
There was a problem hiding this comment.
I'll leave this up to you to decide @hevansDev :)
There was a problem hiding this comment.
Yes, great idea to include the basic python venv method.
|
Suggested a minor change to the opening to more clearerly stress what the two options for accessing the resources are and who they are for with a focus on jupyter server as more of a "default" option and local install as an alternative for students who want to learn to manage their own python environment. Otherwise this new guide looks fantastic @t-redactyl! |
Co-authored-by: Lais Carvalho <lais.bsc@gmail.com>
Hi everyone!
To complement the local install instructions and fulfill our sponsorship agreement with JetBrains, I've overhauled the resources.md page with detailed instructions on how to install everything locally. This is intended to give explanations for complete beginners. I went into this much detail as I've had similar conversations with people at some of the workshops, where they want to know not only how to do things, but why they need to do them.
I realised I didn't add the UV instructions, let me know if I should add them as well, but I wanted to keep it simple and not confuse beginners with too many frameworks.