These are some general best practise tips how to organize your seminar project.
Set up a git account
git is a software that safes your work on the internet so you can always go back to earlier versions if something goes wrong. A bit like a backup system, but also great for collaborative work.
- install the "git" software on your computer
- go to github.com (or try gitlab.org) and get yourself an account.
- make there a new repository, and name it e.g. my-sample-project
- if it's a Python project, select the pathon template for the .gitignore file (this will ignore typical python temporary files for upload).
- go to the main repository page, open the "code" dropdown button and cope the "clone" URL.
- On your computer in a shell/terminal/console, go where your project should reside (I strongly encourage to use a path without whitespace in it) and type
git clone <URL>
and the project folder should be created and is linked with the git repository.
- learn about the basic git commands by searching for a quick tutorial (git cheat sheet).
- install a python version, use version >= 3
set up a virtual environment
- enter your project folder,
- create a virtual environment that will contain all the python packages that you use in your project:
virtualenv -p python3 my-project_env
If virtualenv is not installed, you can either install it or create the environment with
python3 -m venv my-project_env
- then activate the environment
(might be different for other operating systems)
- you should recognize the activated environment by it's name in brackets preceding the prompt, e.g. something like
make the kernel explicit for jupyter
If you use jupyter notebooks, it's safer to explicetely state the python kernel of your environment.
Within the activated envrionment:
python -m ipykernel install --name my-project_env
- if the module ipykernel is not found, you can install it simply with pip:
pip install ipykernel