Ozon3Org / Ozon3

An open-source Python package to easily obtain real-time, historical, or forecasted air quality data for anywhere in the world. Reliable, accurate and simple.
GNU General Public License v3.0
66 stars 24 forks source link

Brief explanation of each parameter that the API can fetch should be added to README #30

Closed Milind220 closed 2 years ago

Milind220 commented 2 years ago

Ozone can currently fetch the following parameters (taken from the Ozone class):

[ "aqi", "pm25", "pm10", "o3", "co", "no2", "so2", "dew", "h", "p", "t", "w", "wg", ]

Some of these parameters, such as 'aqi' are pretty obvious in meaning, but others, such as 'h' , 'w', 'wg', 't' are not easily understood.

It would be excellent to have a short section explaining each parameter briefly in the README, perhaps under the code examples.

You can check the WAQI API website and see if they have the meanings there, or otherwise a google search should prove useful.

Milind220 commented 2 years ago

Hold my beer, I got this

Milind220 commented 2 years ago

I was just testing our new bot out! Feel free to take this :)

kristinamancini commented 2 years ago

Hold my beer, I got this

kristinamancini commented 2 years ago

I have gathered explanations for each parameter, however I am having trouble finding the meaning of the parameter ‘wg’. I searched for the meaning on the WAQI website and others but cannot seem to find it.

Here is what I have so far:

Sources used: WAQI United States Environmental Protection Agency National Weather Service

Milind220 commented 2 years ago

@kristinamancini That's awesome!

Don't worry about the last parameter 'wg'. We can always merge in what you got right now and add the line for 'wg' when someone manages to find it.

You can go ahead and make your PR if you're done making changes! Thanks a lot.