From 5b818460648259faaa08248455434e0b5884284e Mon Sep 17 00:00:00 2001
From: Karim Mache <k.mache@fz-juelich.de>
Date: Sat, 29 Mar 2025 00:47:33 +0100
Subject: [PATCH] creat requirements file
---
.history/README_20250329004717.md | 38 +++++++++++++++++++++++++++++++
README.md | 11 +++++----
2 files changed, 45 insertions(+), 4 deletions(-)
create mode 100644 .history/README_20250329004717.md
diff --git a/.history/README_20250329004717.md b/.history/README_20250329004717.md
new file mode 100644
index 0000000..04f386a
--- /dev/null
+++ b/.history/README_20250329004717.md
@@ -0,0 +1,38 @@
+## TOAR-classifier v2: A data-driven classification tool for global air quality stations
+This study develops a machine learning approach to classify 23,974 air quality monitoring stations in the TOAR database as urban, suburban, or rural using K-means clustering and an ensemble of supervised classifiers. The proposed method outperforms existing classifications, improving suburban accuracy and providing a more reliable foundation for air quality assessments.
+<img src="./figures/toar_classifier_v2.png" alt="My image" with=100>
+
+### Files
+- `data` is the folder containing all the data used in this work, including the predictions of station categories from the Machine Learning (ML) model.
+- `figures` contains all the figures.
+- `TOAR-classifier_v2.ipynb` is the notebook containing the code.
+- `requirements.txt` contains all the necessary packages.
+
+### Run the Code
+
+**Note:** This has been tested on Ubuntu 24.04.
+
+1. Install Python 3 if not already installed (most Linux systems have Python pre-installed).
+2. Install Jupyter Notebook:
+ - `pip install notebook` (for Jupyter Notebook) or
+ - `pip install jupyterlab` (for JupyterLab).
+
+3. clone the project by running the following
+ - `git clone https://gitlab.jsc.fz-juelich.de/esde/toar-public/ml_toar_station_classification.git`
+
+change directory to ml_toar_station_classification
+- `cd ml_toar_station_classification`
+
+creat virtual environment
+- `python -m venv TOAR-classifier_v2` # feel free to change the virtual environment as convenient
+
+activate the created venv
+- `python -m ipykernel install --user --name=TOAR-classifier_v2 --display-name "Python (TOAR-classifier_v2)"`
+
+#### Install required package
+open jupyter notebook, `jupyter-notebook` and select kernel `TOAR-classifier_v2`
+
+Install all the required packages for the project by uncommenting the first cell in the notebook and running the cell
+
+Run the code cell by cell.
+
diff --git a/README.md b/README.md
index 1566ce9..04f386a 100644
--- a/README.md
+++ b/README.md
@@ -18,13 +18,16 @@ This study develops a machine learning approach to classify 23,974 air quality m
- `pip install jupyterlab` (for JupyterLab).
3. clone the project by running the following
-`git clone https://gitlab.jsc.fz-juelich.de/esde/toar-public/ml_toar_station_classification.git`
+ - `git clone https://gitlab.jsc.fz-juelich.de/esde/toar-public/ml_toar_station_classification.git`
-change directory to ml_toar_station_classification, `cd ml_toar_station_classification`
+change directory to ml_toar_station_classification
+- `cd ml_toar_station_classification`
-creat virtual environment `python -m venv TOAR-classifier_v2` # feel free to change the virtual environment as convenient
+creat virtual environment
+- `python -m venv TOAR-classifier_v2` # feel free to change the virtual environment as convenient
-activate the created venv `python -m ipykernel install --user --name=TOAR-classifier_v2 --display-name "Python (TOAR-classifier_v2)"`
+activate the created venv
+- `python -m ipykernel install --user --name=TOAR-classifier_v2 --display-name "Python (TOAR-classifier_v2)"`
#### Install required package
open jupyter notebook, `jupyter-notebook` and select kernel `TOAR-classifier_v2`
--
GitLab