From 00bf96c6a90b9687571f9d393555998d0b02bb03 Mon Sep 17 00:00:00 2001 From: Vincenzo Marciano Date: Wed, 19 Apr 2023 12:38:14 +0200 Subject: [PATCH 1/2] Create README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1fc2093 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# TheUniversityOfSheffield +Code for the internship @The University of Sheffield. + +## How-to: +1) Run 'data_generation.py' which exploits 'data_generator.py' to generate data starting from the indicated subject folder. It relies on "fist_test.ipynb" in the _notebooks_ folder +2) Run 'main.py' which exploits 'weather_analysis.py' to run a weather analysis on cadence etc, generating a statistics file in the _output path_ indicated as argument in the command line. + +## Where-to: +* _notebooks_ contains the experimental notebooks that visually represent the pipeline to generate the files, step by step +* _.py files_ are the files designated to work in a command-line fashion from your terminal. + + From cc66d0281a05586c0e50a0405f60dfdbddce8c2e Mon Sep 17 00:00:00 2001 From: Vincenzo Marciano Date: Wed, 19 Apr 2023 12:40:42 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1fc2093..77b036b 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,12 @@ Code for the internship @The University of Sheffield. ## How-to: 1) Run 'data_generation.py' which exploits 'data_generator.py' to generate data starting from the indicated subject folder. It relies on "fist_test.ipynb" in the _notebooks_ folder -2) Run 'main.py' which exploits 'weather_analysis.py' to run a weather analysis on cadence etc, generating a statistics file in the _output path_ indicated as argument in the command line. +2) Run 'main.py' which exploits 'weather_analysis.py' to run a weather analysis on cadence etc, generating a statistics file in the _output path_ indicated as argument in the command line. It corresponds to _'weather_analysis.ipynb'_ experimental pipeline. ## Where-to: -* _notebooks_ contains the experimental notebooks that visually represent the pipeline to generate the files, step by step +* _notebooks_ contains the experimental notebooks that visually represent the pipeline to generate the files, step by step. _'10s_windowing.ipynb'_ is the first attempt to work with threshold detection, formalized in _'weather_analysis.py'_. Outlier detection pipeline can be visually exploited in 'first_test.ipynb'. * _.py files_ are the files designated to work in a command-line fashion from your terminal. +If you are stucked in the _.py files_ please refer to the corresponding _notebooks_ +