From 1efa07dced2fb3e3657e13eeed2a1611ebf59742 Mon Sep 17 00:00:00 2001
From: Aruzhan Nurman <94863265+aruzhannurman@users.noreply.github.com>
Date: Fri, 28 Feb 2025 15:19:16 +0500
Subject: [PATCH] Create testRead.me

---
 testRead.me | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 testRead.me

diff --git a/testRead.me b/testRead.me
new file mode 100644
index 0000000..db67ff1
--- /dev/null
+++ b/testRead.me
@@ -0,0 +1,44 @@
+# Flood Prediction Project
+
+Flood prediction using LSTM and Deep Learning approaches.
+
+![PyTorch](https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white)
+![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)
+
+# Setup
+
+## Virtual environment
+
+Create a python virtual environment to install all the necessary packages:
+
+```bash
+python -m venv .venv
+```
+
+or 
+
+```bash
+conda create -n flood_proj python=3.10.12
+```
+
+## Installation
+
+Install the required packages into the created virtual environment
+
+```bash
+pip install -r requirements.txt
+```
+
+## WandB Logging
+
+Create `.env` file in `/ML` and add `WANDB_ENTITY` entry.
+
+
+# Data
+
+To prepare the dataset see the [dataset README file](https://github.com/LuftWaffe99/flood-prediction/tree/main/dataset/README.md).
+
+
+# Training
+
+For training models see the [ML README file](https://github.com/LuftWaffe99/flood-prediction/tree/main/ML/README.md).