You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,24 +10,26 @@ The goal of this project is to automate the process of obtaining weather data, a
10
10
11
11
## Key Features
12
12
13
-
-**Automated Data Collection**: A GitHub Action periodically collects weather data from the [wttr.in](https://github.com/chubin/wttr.in) api and stores it in the `data` branch of this repository.v
13
+
-**Automated Data Collection**: A GitHub Action periodically collects weather data from the [wttr.in](https://github.com/chubin/wttr.in) api and stores it in the `data` branch of this repository.
14
14
-**AI-based Weather Forecasting**: The collected data is used to train a machine learning model, which predicts future weather conditions.
15
15
-**Organized Data Management**: The `main` branch contains the core code, while the `data` branch stores all the weather data, keeping the repository clean and efficient.
16
16
-**Customizable Workflow**: The project is designed to be flexible and easily customizable to suit different weather APIs, data analysis methods, and machine learning models.
17
17
18
18
## How It Works
19
+
19
20
### GitHub Actions Workflow
20
21
1.**Data Collection**: The [`action.yml`](.github/workflows/collect_weather_data.yml) is triggered every one hour. It performs the following steps:
21
22
22
23
- Checks out the main branch to run the Python script for collecting weather data.
23
24
- Checks out the data branch to store the collected data.
24
-
- Commits and pushes the new data to the data branch.
25
-
2.**Data Analysis and Forecasting**: `still in development...`
25
+
- Commits and pushes the updated database to the data branch.
26
+
2.**Data Analysis and Forecasting**:
27
+
28
+
`still in development...`
26
29
<!-- An optional GitHub Action (examine-data.yml) can be set up to analyze the data and generate weather forecasts based on the collected data. -->
27
-
28
-
## Next Features
29
-
30
-
1.**Garbage Collector**: A procedure for evaluating data after it has been collected, to avoid data duplications
30
+
3.**Forecasting Website**: a static website for weather forecasts using GitHub Pages
31
+
32
+
`still in development...`
31
33
32
34
## Repository Structure
33
35
@@ -58,11 +60,8 @@ The goal of this project is to automate the process of obtaining weather data, a
58
60
#### Data Branch
59
61
60
62
```python
61
-
├── collected/# The folder containing all the data collected up to now, saved in folders, and divided by city
62
-
│ ├── YYYY--MM-DD_hh-mm-ss/
63
-
│ | ├── New York.json # An example file containing data in json format
64
-
│ |...
65
-
│ ...
63
+
├───...
64
+
└───database.db # Database containing all the weather data collected by the GitHub Actions
66
65
```
67
66
68
67
## Setup Instructions
@@ -76,12 +75,11 @@ The goal of this project is to automate the process of obtaining weather data, a
0 commit comments