Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SanBast authored Apr 19, 2023
1 parent 00bf96c commit cc66d02
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_


0 comments on commit cc66d02

Please sign in to comment.