openKMA 0.0.0.8
My package description
License: MIT
Requires Python: >=3.6
Keywords: opendata,weather

# 소개
기상청은 [공공데이터 포털](https://Data.go.kr)을 통해 기상예보 및 관측정보 등 다양한 기상정보 서비스를 제공합니다.

최근 인공지능 기술로 회귀분석, 시계열예측, 이미지학습, 자연어처리 등이 일반화되고 기상자료는 매일 지상관측, 기상예보, 레이더/위성 이미지, 기상통보문 등 다양한 형태로 생산되어 빅데이터를 이루고 있습니다. 본 패키지는 **Python3**를 기반으로 **기상청 API**를 편리하게 사용할 목적으로 배포하였으며 데이터 사이언스 분야에 많이 활용되는 **Numpy** 와 **Pandas** 를 주로 사용합니다. 또한 기상자료시각화를 위해서 **Matplotlib**과 **Cartopy**, 자료저장을 위한 **netCDF4**, **h5py** 등을 사용한 일부 예제를 제공합니다.

*현재 서비스 활용순으로 기능을 추가 중이며 공공 데이터 포털을 통한 ***openKMA*** 사용 및 문의는 eom.taeyoon.kor@gmail.com 으로 메일바랍니다.*

(2023년 2월 15일 기준)
* [동네예보 조회서비스(VilageFcstInfoService2.0)](https://www.data.go.kr/data/15084084/openapi.do)
* [중기예보 조회서비스(MidFcstInfoService)](https://www.data.go.kr/data/15059468/openapi.do)
* [동네예보 통보문 조회서비스(VilageFcstMsgService)](https://www.data.go.kr/data/15058629/openapi.do)
* [지상(종관, ASOS) 시간자료 조회서비스(AsosHourlyInfoService)](https://www.data.go.kr/data/15057210/openapi.do)
* [지상(종관, ASOS) 일자료 조회서비스(AsosHourlyInfoService)](https://www.data.go.kr/data/15059093/openapi.do)
* [수치모델자료(경량화) 조회서비스(NwpModelInfoService)](https://www.data.go.kr/data/15043588/openapi.do)
* [기상특보 조회서비스(WthrWrnInfoService)](https://www.data.go.kr/data/15000415/openapi.do)
* [태풍정보 조회서비스(TyphoonInfoService)](https://www.data.go.kr/data/15043565/openapi.do)
* [지진정보 조회서비스(EqkInfoService)](https://www.data.go.kr/data/15000420/openapi.do)
* [기상청_지진정보(EqkInfoService)](https://www.data.go.kr/data/15000420/openapi.do)
* [생활기상지수 조회서비스(LivingWthrIdxServiceV3)](https://www.data.go.kr/data/15085288/openapi.do)
* [관광코스별 관광지 상세 날씨 조회서비스(TourStnInfoService1)](https://www.data.go.kr/data/15056912/openapi.do)
* [일기도 조회서비스(WthrChartInfoService)](https://www.data.go.kr/data/15043562/openapi.do)
* [레이더관측자료 조회서비스(RadarObsInfoService)](https://www.data.go.kr/data/15057166/openapi.do)
  <details>
    <summary>(예정)</summary>
    
    * 위성영상 조회서비스(getInsightSatlit)  
    * 보건기상지수 조회서비스(HealthWthrIdxService)  
    * 레이더영상 조회서비스(RadarImgInfoService)  
    * 지상(방재, AWS)기상관측자료 조회서비스(Aws1miInfoService)  
    * CCTV 기반 도로날씨정보 조회서비스(RoadWthrInfoService)  
    * 낙뢰분포도 조회서비스(LgtDistrbInfoService)  
    * 작물별 농업주산지 상세날씨 조회서비스(FmlandWthrInfoService)  
    * 위성자료(경량화) 조회서비스(WthrSatlitInfoService)  
    * 지상기상월보 조회서비스(SfcMtlyInfoService)
    * 낙뢰관측자료 조회서비스(LgtInfoService)  
    * 항공기상전문(IWXXMVer.2.0) 조회서비스(AmmIwxxmService)  
    * 해양기상관측자료 조회서비스(OceanInfoService)  
    * 서리발생 가능성 예측정보 조회서비스(FrstFcstInfoService)  
    * 지상기상연보 조회서비스(SfcYearlyInfoService)  
    * 레이더자료(경량화) 조회서비스(WthrRadarInfoService)  
    * 방재기상월보 조회서비스(AwsMtlyInfoService)  
    * 해양기상월보 조회서비스(SeaMtlyInfoService)  
    * 항공기상전문 조회서비스(AmmService)_기상청에서 운영하는 관측지점, 기상예보구역, 기상특보구역 등에 대한 정보를 제공합니다. ※ 방재기상업무 수행을 위해 공공기관에 한해서 제공하는 자료입니다. 활용목적을 정확히 적어주시기 바랍니다.  
    * 지점정보(기상관측, 특보구역) 조회서비스(WethrBasicInfoService)  
    * 황사정보 조회서비스(YdstInfoService)_황사일기도, 황사관측값, 황사위성영상 정보를 조회하는 서비스 ※ 방재기상업무 수행을 위해 공공기관에 한해서 제공하는 자료입니다. 활용목적을 정확히 적어주시기 바랍니다.  
    * 고층기상월보 조회서비스(UppMtlyInfoService)  
    * 방재기상연보 조회서비스(AwsYearlyInfoService)  
    * 세계공항 항공기상전문 조회서비스(AftnAmmService)  
    * 고층기상관측자료 조회서비스(UppInfoService)  
  </details>

# 설치방법
## 의존성 패키지
***pip install requests*** or ***conda install -c conda-forge requests***  
***pip install pandas*** or ***conda install -c conda-forge pandas***  
***pip install numpy*** or ***conda install -c conda-forge numpy***  

## openKMA 설치
***pip install openKMA***

# 사용방법
## 사전준비
### API 인증키 발급
<img src="ServiceKey.png" width="64%">

[공공데이터 포털](https://Data.go.kr)에 가입해서 원하는 서비스에 대하여 활용신청을 합니다.  
마이페이지에서 해당 서비스 정보를 확인하면 **"일반 인증키(Decoding)"** 항목이 표시됩니다.  
일반 인증키는 API의 **ServiceKey**로 사용됩니다.
## 서비스 사용방법
서비스 목록 중 필요한 서비스를 **from** 과 **import** 를 사용하여 아래와 같이 **ServiceKey**를 넣어서 사용하세요.
```python
from datetime import datetime, timedelta
from openKMA import VilageFcstInfoService  

# 단기예보 조회서비스(2.0) 사용하기
KMA = VilageFcstInfoService("일반 인증키(Decoding)를 복사해 넣으세요")

baseDateTime = datetime.now() + timedelta(hours=-6) # 6시간 전을 기준(base)
response = KMA.getVilageFcst(baseDateTime, X, Y) # <- 단기예보조회 API 사용

print(response.url) # <------------ Callback URL 주소 
print(response.parameters) # <----- 요청항목
print(response.response.url) # <--- Full URL
print(response.resultCode) # <----- 응답메세지 코드
print(response.resultMsg) # <------ 응답메세지
print(response.dataType) # <------- 응답데이터 타입
print(response.items) # <---------- DataFrame 혹은 Numpy 등으로 가공된 최종자료
```

기상자료를 일반적으로 시간에 따른 자료가 많아 Python의 기본내장 클래스인 ***datetime***을 주로 이용하고 서비스 별로 자료조회 및 생산주기가 다르기 때문에 상세페이지의 **가이드 문서**를 참고해 ***timedelta***함수를 적절히 사용하시면 편리하게 **openKMA**을 사용하실 수 있습니다. 반드시 서비스의 **가이드 문서**를 숙지하시기 바랍니다.
기본 예제는 [example폴더](example)에서 확인가능하며 일부 시각화 및 자료저장 예제를 포함합니다.

# 서비스 목록
<details>
  <summary><strong>1. 예보정보 관련 서비스</strong></summary>
    
  ## 1.1 기상청_단기예보 ((구)_동네예보) 조회서비스(VilageFcstInfoService2.0)
  |서비스명|기능|인자|반환(item)|기타|
  |------|---|---|---|---|
  |예보버전조회|**getFcstVersion**|파일구분, 발표시각|datetime|'ODAM':실황/'VSRT':초단기예보/'SHRT':동네예보|
  |동네예보조회|**getVilageFcst**|X좌표, Y좌표, 발표시각|DataFrame|1일 8회 02시부터 3시간 간격으로 제공|
  |초단기예보조회|**getUltraSrtFcst**|X좌표, Y좌표, 발표시각|DataFrame|매시간 30분에 생성, 30분 발표|
  |초단기실황조회|**getUltraSrtNcst**|X좌표, Y좌표, 발표시각|DataFrame|매시간 30분에 생성, 00분 발표|

  * 모든 서비스는 24시간 이내에 자료만 조회가 가능하며 발표시각(baseDatetime)은 [활용가이드](https://www.data.go.kr/data/15084084/openapi.do) 참고
  * 동네별 X, Y좌표는 활용가이드 혹은 [기상자료개방포털](https://data.kma.go.kr/cmmn/main.do)의 자료실 참고
  * [사용예시](example/basic_VilageFcstInfoService.py)

  ## 1.2 중기예보 조회서비스(MidFcstInfoService)
  |서비스명|기능|인자|반환(item)|기타|
  |------|---|---|---|---|
  |중기전망조회|**getMidFcst**|지점번호, 발표시각|String|중기전망 지점코드 참고|
  |중기기온조회|**getMidTa**|예보구역코드, 발표시각|DataFrame|중기기온 지점코드 참고|
  |중기육상예보조회|**getMidLandFcst**|예보구역코드, 발표시각|DataFrame|중기육상예보구역 코드 참고|
  |중기해상예보조회|**getMidSeaFcst**|예보구역코드, 발표시각|DataFrame|중기해상예보구역 코드 참고|
  * 중기예보는 모두 일 2회 (6시, 18시) 생산되며 최근 24시간 자료만 제공
  * 서비스별 지점 및 구역 코드는 해당 서비스의 [활용가이드](https://www.data.go.kr/data/15059468/openapi.do) 참고
  * [사용예시](example/basic_MidFcstInfoService.py)

  ## 1.3 동네예보 통보문 조회서비스(VilageFcstMsgService)
  |서비스명|기능|인자|반환(item)|기타|
  |------|---|---|---|---|
  |기상개황조회|**getWthrSituation**|발표관서|DataFrame|발표관서 참고|
  |육상예보조회|**getLandFcst**|예보구역코드|DataFrame|예보구역코드 참조|
  |해상예보조회|**getSeaFcst**|예보구역코드|DataFrame|예보구역코드 참조|
  * 동네예보 통보문은 모두 일 3회 (5시, 11시, 17시) 발표됩니다.
  * 통보문 발표시각(~조회시각): 5시(~11시), 11시(~17시), 17시(~다음날 5시)
  * 조회시간에 상관없이 가장 최근에 통보문만 조회됩니다.
  * [사용예시](example/basic_VilageFcstMsgService.py)

</details>

___

<details>
  <summary><strong>2. 관측정보 관련 서비스</strong></summary>

## 2.1 지상(종관, ASOS) 시간자료 조회서비스(AsosHourlyInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|기상관측시간자료목록조회|**getWthrDataList**|지점번호, 시작시각, 종료시각|DataFrame|한 번에 최대 999개까지 조회 가능|

* 조회기간은 지점별 운영기간 모두 가능하며, 전날 자료까지만 조회가능합니다. 
* 단, 서버사정에 따라 갱신이 늦을 수 있습니다. (보통 오전 10시 이후 전부 조회 가능)
* 한 번에 최대 999개까지 조회되기 때문에 기간은 한 달이내로 설정해주시기 바랍니다.  
* [사용예시](example/basic_AsosHourlyInfoService.py)

## 2.2 지상(종관, ASOS) 일자료 조회서비스(AsosDalyInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|기상관측일자료목록조회|**getWthrDataList**|지점번호, 시작날짜, 종료날짜|DataFrame|한 번에 최대 999개까지 조회 가능|
* 조회기간은 지점별 운영기간 모두 가능하며, 전날 자료까지만 조회가능합니다. 
* 단, 서버사정에 따라 갱신이 늦을 수 있습니다. (보통 오전 10시 이후 전부 조회 가능)
* 한 번에 최대 999개까지 조회되기 때문에 기간은 2년 이내로 설정해주시기 바랍니다.  
* [사용예시](example/basic_AsosDalyInfoService.py)

</details>

---

<details>
  <summary><strong>3. 위성 및 레이더 관련 서비스</strong></summary>
  (예정)
</details>

---

<details>
  <summary><strong>4. 수치예보 관련 서비스</strong></summary>

## 4.1 수치모델자료(경량화) 조회서비스(NwpModelInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|국지예보모델단일면한반도조회|**getLdapsUnisAll**|발표시간, 자료종류, 리드시간|Dictionary|-|
|국지예보모델단일면행정구역조회|**getLdapsUnisArea**|발표시간, 자료종류, 행정구역|DataFrame|-|
|지역예보모델단일면한반도조회|**getRdapsUnisAll**|발표시간, 자료종류, 리드시간, 행정구역|Dictionary|-|
|지역예보모델단일면행정구역조회|**getRdapsUnisArea**|발표시간, 자료종류, 행정구역|DataFrame|-|
* 특보는 오늘을 기준으로 6일 전 자료까지만 조회됩니다.
* 한반도조회 정보는 Dictionary형태로 반환하며 Key는 아래와 같다.
* ```{'baseTime':발표시간, 'fcstTime':예측시간, 'gridKm':격자크기, 'xdim':x크기, 'ydim':y크기, 'x0':x기준점, 'y0':y기준점, 'unit':단위, 'value':데이터 }```
* [사용예시](example/basic_NwpModelInfoService.py)
* [시각화](example/visualize_NwpModelInfoService.py)
* 
</details>

---

<details>
  <summary><strong>5. 특보 및 지진/태풍 관련 서비스</strong></summary>

## 5.1 기상특보 조회서비스(WthrWrnInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|기상특보목록조회|**getWthrWrnList**|지점코드, 시작날짜, 종료날짜|DataFrame|-|
|기상특보통보문조회|**getWthrWrnMsg**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상정보목록조회|**getWthrInfoList**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상정보문조회|**getWthrInfo**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상속보목록조회|**getWthrBrkNewsList**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상속보조회|**getWthrBrkNews**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상예비특보목록조회|**getWthrPwnList**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상예비특보조회|**getWthrPwn**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|특보코드조회|**getPwnCd**|지점번호, 특보구역코드, 특보종류, 시작날짜, 종료날짜|DataFrame|1:강풍, 2:호우, 3:한파, 4:건조, 5:폭풍해일,<br>6:풍랑, 7:태풍, 8:대설, 9:황사, 12:폭염|
|특보현황조회|**getPwnStatus**| - |DataFrame|-|
* 특보는 오늘을 기준으로 6일 전 자료까지만 조회됩니다.
* 조회기간 동안 특보가 없을 시 반환 값이 없습니다.
* [사용예시](example/basic_WthrWrnInfoService.py)

## 5.2 태풍정보 조회서비스(TyphoonInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|태풍정보조회|**getTyphoonInfo**|\[발표시각\], \[종료날짜\]|DataFrame|-|
|태풍정보목록조회|**getTyphoonInfoList**|\[발표시각\]|DataFrame|-|
|태풍예상정보조회|**getTyphoonFcst**|발표시각, 태풍번호|DataFrame|-|
* 태풍정보는 오늘을 기준으로 3일 전 자료까지만 조회됩니다.
* 조회기간 동안 특보가 없을 시 반환 값이 없습니다.
* [사용예시](example/basic_TyphoonInfoService.py)

## 5.3 지진정보 조회서비스(EqkInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|지진통보문조회|**getEqkMsg**|발표시각, 종료날짜|DataFrame|-|
|지진통보문 목록조회|**getEqkMsgList**|발표시각, 종료날짜|DataFrame|-|
|지진해일통보문조회|**getTsunamiMsg**|발표시각, 종료날짜|DataFrame|-|
|지진해일통보문 목록조회|**getTsunamiMsgList**|발표시각, 종료날짜|DataFrame|-|
* 지진정보는 오늘을 기준으로 3일 전 자료까지만 조회됩니다.
* 조회기간 동안 특보가 없을 시 반환 값이 없습니다.
* [사용예시](example/basic_EqkInfoService.py)

</details>

---

<details>
  <summary><strong>6. 생활 및 산업 관련 서비스</strong></summary>

## 6.1 기상청_생활기상지수 조회서비스(LivingWthrIdxServiceV3)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|동파가능지수조회|**getWthrWrnList**|지점코드, 시작날짜, 종료날짜|DataFrame|-|
|자외선지수조회|**getWthrWrnMsg**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|대기확산지수조회|**getWthrInfoList**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|체감온도(여름철)조회|**getWthrInfo**|지점번호, 시작날짜, 종료날짜|DataFrame|-|
|기상예비특보조회|**getWthrPwn**|지점번호, 시작날짜, 종료날짜|DataFrame|A41 : 노인 A42 : 어린이 A44 : 농촌 A45 : 비닐하우스 A46 : 취약거주환경 A47 : 도로 A48 : 건설현장 A49 : 조선소|
* 생활기상지수별 제공기간: 동파(11~3월), 자외선(연중), 대기확산(연중), 체감온도(5~9월)
* [사용예시](example/basic_LivingWthrIdxServiceV3.py)

## 6.2 관광코스별 관광지 상세 날씨 조회서비스(TourStnInfoService1)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|시군구별관광기후지수조회|**getCityTourClmIdx1**|시군구ID, 조회날짜, 조회기간(Day)|DataFrame|-|
|동네예보조회|**getWthrWrnMsg**|관광코스ID, 조회날짜, 조회기간(Hour)|DataFrame|-|
* [사용예시](example/basic_TourStnInfoService1.py)

</details>

---

<details>
  <summary><strong>7. 기타</strong></summary>

## 7.1 일기도 조회서비스(WthrChartInfoService)
|서비스명|기능|인자|반환(item)|기타|
|------|---|---|---|---|
|지상일기도조회|**getSurfaceChart**|시간, 지상코드|String(URL)|-|
|보조일기도조회|**getAuxillaryChart**|시간, 지상코드, 보조코드|String(URL)|-|
* [사용예시](example/basic_WthrChartInfoService.py)

</details>

---

# 참고
+ [공공데이터 포털](https://www.data.go.kr/)
+ [기상자료개방포털](https://data.kma.go.kr/cmmn/main.do)
+ [기상청(Korea Meteorological Administration)](http://www.kma.go.kr/)

# 감사드리는 분
부족하지만 항상 따뜻하게 대해주시고, 함께 고민해주시는 분들께 감사의 마음을 전합니다.
+ 충남대학교 천문우주학과 대기과학 교수님 및 연구원들
+ 공주대학교 대기과학과 교수님 및 동기, 선후배들
+ 공주대학교 대기과학과 환경방 형님들
+ 대전지방기상청 예보관 아무개
+ 기상청 국가기후데이터센터 아무개