Skip to content

Commit

Permalink
rewrite readme.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
toravest committed May 24, 2025
1 parent a369d4f commit d29ae70
Show file tree
Hide file tree
Showing 6 changed files with 95 additions and 45 deletions.
74 changes: 44 additions & 30 deletions README.md

Large diffs are not rendered by default.

39 changes: 30 additions & 9 deletions data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,36 @@

Her vil det opprettes ulike mapper som et resultat av dataene som lagres gjennom kjøringen av de ulike notebookene.

Funksjonen er bygd slik at den først sjekker om det eksisterer en mappe, før den eventuelt lager. Alle mapper som starter med output (altså output data) er lagt til i `.gitignore`. Dette for å ikke laste opp masse unødvendig til github, men også for at brukere ikke 'deler' data. Mine kjøringer vil være mine, og dine vil kun vises hos deg.
Funksjonen er bygd slik at den først sjekker om det eksisterer en mappe, før den eventuelt lager. Mappen er delt opp i `data/figures` og `data/json`, dette for å lettere skille mellom dataen fra de ulike notebook-ene.

Alle mapper som starter med output er lagt til i `.gitignore`. Dette for å ikke laste opp masse unødvendig til github, men også for at brukere ikke 'deler' data. Mine kjøringer vil være mine, og dine vil kun vises hos deg.

Det er også en test-mappe, her har vi lagret noe data hentet med API-en, som inneholder feil og mangler. Denne vil bli brukt i `notebook_regression.ipynb` for å vise at funksjonene våre for renskning fungerer, før dataen blir splittet og trener opp en regresjonsmodell.

Dette er eksempel på noen av mappene:
- `test` inneholder forhåndslagret data for bruk i `notebook_regression.ipynb`
- `output_current_data` lagrer dataen for ønsket sted, kjørt fra `notebook_current_data.ipynb`
- `output_fig` lagrer grafer, kjørt fra `notebook_statistic_data.ipynb`
- `output_record` lagrer rekord data fra ønsket sted, kjørt fra `notebook_statistic_data.ipynb`
- `output_statistikk` lagrer dataen for ønsket sted, kjørt fra`notebook_statistic_data.ipynb`
- `output_sammenligning_dag` lagrer data for to ønsket steder for dags sammenligning, kjørt fra `notebook_compare_one_day_data.ipynb`
- `output_fig_sammenligning` lagrer sammenligningsgrafer, kjørt fra de ulike 'compare' notebookene
Dette er mappenestrukturen:
`data/figures`:
- `output_fig_compare_one_day`
- `output_fig_compare_one_week`
- `output_fig_compare_statistic`
- `output_fig_interactive`
- `output_fig_one_day`
- `output_fig_one_week`
- `output_fig_statistic`

Figurene som lagres vil være blant annet:
- Værdata (temperatur, nedbør og vind)
- Temperatur (gjennomsnitt, maks og min)
- Korrelasjonsmatriser

`data/json`:
- `output_compare_one_day`
- `output_compare_one_week`
- `output_compare_statistic`
- `output_current`
- `output_interactive`
- `output_one_day`
- `output_one_week`
- `output_records`
- `output_statistic`

Data som lagres er json-filer med data hentet fra API-en. Og i `output_records` vil det lagres rekord verdier regnet fra `notebook_statistic_data`.
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Documents
KI - declaration

### Refleksjonsnotat
[Refleksjonsnotat](./refleksjonsnotat.md), her har vi snakket om vår erfaring av prosjektet, hva vi har lært om både programmering og samarbeid. Litt problemer vi har møtt på veien, og litt refleksjon rundt hva om kunne vært gjort annerledes. Men det viktigste er vår refleksjon over egen læring.

### KI - declaration

Første deklarasjon:
[Se KI-deklarasjonen](./KI_one_declaration.pdf)
Expand Down
4 changes: 3 additions & 1 deletion notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Her finnes informasjon om de ulike notebookene og deres innhold.
Denne notebooken henter data for ønsket periode (inntil 7-dager) fra to steder, og sammenglinger verdiene. Dataen fra begge stedene lagres i samme json-fil, og hentes ut ved hjelp av Pandas SQL.
- [Compare statistic data](notebook_compare_statistic_data.ipynb)
Denne notebooken henter data fra en API som samler alle historiske data for to ønskede steder, og sammenglinger verdiene. Dataen fra begge stedene lagres i samme json-fil, og hentes ut ved hjelp av Pandas SQL.
- [Interactive](notebook_interactive)
Denne notebooken henter data for ønsket dag og sted, skriver til fil. Lager en interaktiv visualisering hvor bruker kan endre på dot-størrelsen, farger og velge om rutenett og gjennomsnittslinjen skal være synlig.
- [Regression](notebook_regression.ipynb)
Denne notebooken henter data fra et test-fil, hvor vi vet det er mangler, og kjører rensking av dataen før den splittes og trener opp en regresjonsmodell. Du kan også legge inn ulike verdier til variablene for å se regresjonen i live-action.
Denne notebooken henter data fra et test-fil, hvor vi vet det er mangler, og kjører rensking av dataen før den splittes og trener opp en regresjonsmodell. Bruker kan også legge inn ulike verdier til variablene for å se regresjonen i live-action.
- [Test notebook](test_notebook.ipynb)
Dette er bare en test notebook, for å se om venv funker og det å importere funksjoner fra packager.
13 changes: 11 additions & 2 deletions resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,19 @@ For å benytte denne API-en må man lage en bruker, og som student for man tilga

### Possible API
- **API from openweathermap**
[API_OPEN_WEATHER_MAP](https://openweathermap.org/)
- [Current Data](https://openweathermap.org/current): for å hente ut data fra ønsket sted på nåværende tidspunkt.
- [History API](https://openweathermap.org/history): for å hente data fra ønsket sted og tidsperiode (inntil 7 dager).
- [Statistic Historical Data](https://openweathermap.org/api/statistics-api): for å hente statistisk historisk data som kan brukes til regresjon. Den tar utganspunkt i all historisk data og oppsummerer det for hver dag i året.

- **API from meterologisk institutt**
[API_FROST](https://frost.met.no/index.html)
- [Airqualityforecast](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation)
Vanskelig å kunne hente data fra ønsket sted, komplisert request med masse data.
- [Frost](https://frost.met.no/index.html)
Vanskelig å kunne hente data fra ønsket sted, stasjonsbasert.
- [Locationforecast](https://api.met.no/weatherapi/locationforecast/2.0/documentation)
Enkel å finne data fra ønsket sted, men bare en forecast, så finner ikke historiske data.
- [Vaer og klima](https://www.met.no/vaer-og-klima/klima-siste-150-ar)
Mye historisk data, men hadde kun for regioner og ikke for steder slik vi ønsket.

### Possible dataset
- **Natural Disasters:**
Expand Down
4 changes: 2 additions & 2 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ Her kommer en kjapp forklaring av de ulike filene og deres funksjoner:
- Konverterer grader fra kelvin til celsius
- Sjekker at ønskede kolonner eksisterer i datasettet
- Fyller "NaN" verdier med 0, i ønskede kolonner
- Fjerner alle uønskede kolonner med samme endelse (notebook_statistic_data.ipynb)
- Henter rekord målinger (notebook_statistic_data.ipynb)
- Fjerner alle uønskede kolonner med samme endelse (`notebook_statistic_data.ipynb`)
- Henter rekord målinger (`notebook_statistic_data.ipynb`)
- `test_module.py` en test funksjon for å sjekke at venv og implementering til notebook funker som det skal.

0 comments on commit d29ae70

Please sign in to comment.