Laura Wagner commited on
Commit ·
5cd8c97
1
Parent(s): ef9e77c
add readme
Browse files
README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Code
|
| 2 |
+
|
| 3 |
+
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
# Project Setup
|
| 7 |
+
|
| 8 |
+
## Requirements
|
| 9 |
+
This project requires Python 3.8 or higher. Ensure you have it installed before proceeding.
|
| 10 |
+
|
| 11 |
+
## Installation
|
| 12 |
+
|
| 13 |
+
1. **Clone the Repository**
|
| 14 |
+
```sh
|
| 15 |
+
git clone <your-repository-url>
|
| 16 |
+
cd <your-project-directory>
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
2. **Create a Virtual Environment**
|
| 20 |
+
(Recommended to avoid dependency conflicts)
|
| 21 |
+
```sh
|
| 22 |
+
python -m venv venv
|
| 23 |
+
source venv/bin/activate # On macOS/Linux
|
| 24 |
+
venv\Scripts\activate # On Windows
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
3. **Install Dependencies**
|
| 28 |
+
```sh
|
| 29 |
+
pip install -r requirements.txt
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
4. **Jupyter Notebook Setup (Optional)**
|
| 33 |
+
If running Jupyter notebooks, ensure the environment is linked:
|
| 34 |
+
```sh
|
| 35 |
+
python -m ipykernel install --user --name=venv --display-name "Python (venv)"
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
5. **Run the Project**
|
| 39 |
+
- If using Jupyter Notebook:
|
| 40 |
+
```sh
|
| 41 |
+
jupyter lab
|
| 42 |
+
```
|
| 43 |
+
- If running a script:
|
| 44 |
+
```sh
|
| 45 |
+
python your_script.py
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## Notes
|
| 49 |
+
- Ensure you have necessary system dependencies installed (e.g., `opencv` may require additional system libraries).
|
| 50 |
+
- If you encounter any issues, ensure you're using the correct Python environment (`venv` activated).
|
| 51 |
+
```
|
| 52 |
+
|