/meteodata

Live Demo [Beta]

Primary LanguageJupyter NotebookMIT LicenseMIT

Docker workflow Quality workflow Django CI Pylint Score

meteodata

Project structure is as follow:

Further documentation will be available in the upcoming days

TL;DR

to run the current version on your machine, do the following :

  1. Pull the image from the docker hub.
docker pull fedihamdi/breatheeasyapp:latest
  1. Start the app.
docker run -it -p 8000:8000 fedihamdi/breatheeasyapp:latest

πŸš€ Building and Running locally (no docker needed)

  1. Clone the current repo.
git clone https://github.com/fedihamdi/meteodata.git
  1. Go to repo "meteodata/src/reaper"
cd ~/meteodata/src/reaper
  1. Create and install the requirements (I am using conda)
  • Create conda env
conda create -n meteodata_39 python==3.9.18
  • activate conda env
conda activate meteodata_39
  • Install requirements
pip install -r requirements.txt

πŸ‘‰ Once that is done, you are ready to go :

py manage.py makemigrations
python manage.py migrate

πŸ‘‰ Create the Superuser

python manage.py createsuperuser

πŸ‘‰ Start the app

py manage.py runserver 0.0.0.0:8000

πŸ₯‡ At this point, the app runs at ➑️ http://localhost:8000/

Codebase structure

~:.
β”‚   .gitattributes
β”‚   .gitignore
β”‚   data_file_2022-07-10.csv
β”‚   download.nc
β”‚   download_pollen_forcasts.nc
β”‚   interactive_map_corrected.html
β”‚   interactive_map_corrected_bright.html
β”‚   LICENSE
β”‚   main.py
β”‚   random_data.nc
β”‚   random_data2.nc
β”‚   README.md
β”‚   requirements.txt
β”‚   testapi.py
β”‚
β”œβ”€β”€β”€.idea
β”‚   β”‚   .gitignore
β”‚   β”‚   meteodata.iml
β”‚   β”‚   misc.xml
β”‚   β”‚   modules.xml
β”‚   β”‚   vcs.xml
β”‚   β”‚   workspace.xml
β”‚   β”‚
β”‚   └───inspectionProfiles
β”‚           profiles_settings.xml
β”‚
β”œβ”€β”€β”€.ipynb_checkpoints
β”œβ”€β”€β”€models
β”‚       random_forest_dumb_model.pkl
β”‚
β”œβ”€β”€β”€notebooks
β”‚   β”‚   Modelisation.ipynb
β”‚   β”‚   R&D + EDA.ipynb
β”‚   β”‚
β”‚   └───.ipynb_checkpoints
β”‚           Modelisation-checkpoint.ipynb
β”‚           R&D + EDA-checkpoint.ipynb
β”‚
β”œβ”€β”€β”€src
β”‚   β”‚   cams_data_retrieval.py
β”‚   β”‚   era5_data_retriever.py
β”‚   β”‚   model_job.py
β”‚   β”‚   processing_job.py
β”‚   β”‚   __init__.py
β”‚   β”‚
β”‚   β”œβ”€β”€β”€app
β”‚   β”‚   β”‚   app.py
β”‚   β”‚   β”‚   __init__.py
β”‚   β”‚   β”‚
β”‚   β”‚   └───Breatheeasy
β”‚   β”‚       β”‚   db.sqlite3
β”‚   β”‚       β”‚   manage.py
β”‚   β”‚       β”‚   __init__.py
β”‚   β”‚       β”‚
β”‚   β”‚       β”œβ”€β”€β”€Breatheeasy
β”‚   β”‚       β”‚   β”‚   asgi.py
β”‚   β”‚       β”‚   β”‚   settings.py
β”‚   β”‚       β”‚   β”‚   urls.py
β”‚   β”‚       β”‚   β”‚   views.py
β”‚   β”‚       β”‚   β”‚   wsgi.py
β”‚   β”‚       β”‚   β”‚   __init__.py
β”‚   β”‚       β”‚   β”‚
β”‚   β”‚       β”‚   └───__pycache__
β”‚   β”‚       β”‚           settings.cpython-310.pyc
β”‚           era5_data_retriever.cpython-310.pyc
β”‚
└───tests
    β”œβ”€β”€β”€integration
    └───unit