Initial commit

README.md

@@ -0,0 +1,41 @@
+# Real Video Labeling Tool Py
+Python rewrite of [Real-Video-Annotation-Tool]
+
+## 1. Installation
+Here are two options to setup the project.
+
+### 1.1.1 Setup with Conda
+1. If [conda] is not yet installed, follow the [installation guide] for your operating system.
+   > Note: [miniconda] and especially [mamba] are faster and lighter than Anaconda
+2. From the projects root directory create the environment with:
+   ```
+   conda env create -f environment.yml
+   ```
+3. Activate the new environment with:
+   ```
+   conda activate labeling_tool
+   ```
+   > Note: The environment should always be activated when working on this project
+4. To update the environment after changes in environment.yml run:
+```conda env update --name labeling_tool --file environment.yml --prune```
+
+#### Troubleshoot
+- Make sure to restart your terminal after installing conda. Or run ```source ~/.bashrc```
+- Run ```conda config --set auto_activate_base false``` to deactivate automatic conda activation on startup
+- If ```conda activate``` fails, try ```conda init``` and then ```conda activate``` again
+
+### 1.1.2 Install dependencies with pip
+You can also install dependencies with pip:
+```pip install -r requirements.txt```
+
+### 1.2 Run
+Run program with ```python3 src/main.py``` or from within IDE.
+Images and Labels are stored in /Storage
+
+
+## Note
+[Real-Video-Annotation-Tool]: https://sam-dev.cs.hm.edu/SAM-DEV/Sampler_CNN_Training
+[conda]: https://docs.conda.io/
+[installation guide]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html
+[miniconda]: https://docs.conda.io/en/latest/miniconda.html
+[mamba]: https://mamba.readthedocs.io/en/latest/installation.html#installation