AWS GOES16 - API Wrapper

AWS GOES16 API Wrapper é uma API Wrapper desenvolvida para facilitar o acesso e download aos dados dos diferentes produtos do satélite NOAA GOES 16 presentes na storage da AWS (S3) que pode ser utilizada a partir de importação de seu módulo em um notebook por exemplo, ou via CLI.

Sumário

• Guia Inicial
  • Instalação
    • Uso via importação
    • Uso via CLI
  • Exemplos
• Documentação

Guia inicial

A AWS GOES16 API Wrapper pode ser utilizado de duas maneiras distintas em seus projetos. A primeira é através da sua forma programática, ou seja, realizando a importação do módulo do projeto em um notebook por exemplo e utilizando de suas classes conforme a documentação. A segunda forma é através de uma CLI (Command Line Interface). Nessa forma, basta executar o processo de instalação e utilizar da CLI seguindo o que foi especificado na documentação.

Para cada uma das duas formas citadas acima é feito um processo de instalação próprio. Abaixo você pode conferir como realizar o processo de instalação das duas formas:

Instalação

Forma programática

Primeiro, faça o clone do repositório do projeto mais recente para seu ambiente local:

git clone https://github.com/anthonyvii27/aws-goes16-api-wrapper.git
cd aws-goes16-api-wrapper
pip install -r requirements.txt

Feito isso, insira o projeto dentro do seu ambiente de trabalho e faça as importações necessárias para utilizar das classes e métodos do goes16 dentro do seu projeto.

Você pode encontrar exemplos de como utilizar da AWS GOES16 API Wrapper nos exemplos presentes dentro da pasta docs

Via CLI

Para utilizar o projeto via CLI o processo inicial é o mesmo da forma programática. Primeiramente, realize o clone do repositório do projeto para seu ambiente local:

git clone https://github.com/anthonyvii27/aws-goes16-api-wrapper.git
cd aws-goes16-api-wrapper
pip install -r requirements.txt

Após isso, dentro pasta do projeto, rode o comando abaixo para instalar a CLI no seu ambiente:

make install

Feito isso, é possível acessar a CLI diretamente no seu terminal utilizando do comando awsgoes16. Para testar se tudo está funcionando perfeitamente, rode o comando abaixo:

awsgoes16 --help

Exemplos - Via importação

Abaixo estão alguns exemplos de como utilizar a API Wrapper do NOAA GOES16 de forma programática. Todos os exemplos podem ser encontrados na pasta examples presente dentro da pasta docs.

Criando a instância da awsgoes16

from awsgoes16.src.awsS3ApiGoes16 import AwsS3ApiGoes16

api_goes = AwsS3ApiGoes16()

Listando os arquivos presentes em um bucket (local e remoto)

from awsgoes16.src.awsS3ApiGoes16 import AwsS3ApiGoes16
api_goes = AwsS3ApiGoes16()

# USING THE LOCAL BUCKET ALIAS = 'local'
api_goes.list_bucket_files(bucket_name='local')

# REMOTE BUCKET
api_goes.list_bucket_files()

Definindo os parâmetros de coordenadas (latitude e longitude) para filtragem dos dados dos arquivos

from awsgoes16.src.awsS3ApiGoes16 import AwsS3ApiGoes16
api_goes = AwsS3ApiGoes16()

api_goes.lat_long_coords = {'n_lat': -22.5, 's_lat': -24.0, 'w_lon': -43.8, 'e_lon': -43.0}

Fazendo o download de um arquivo específico

from awsgoes16.src.awsS3ApiGoes16 import AwsS3ApiGoes16
api_goes = AwsS3ApiGoes16()

api_goes.get_file(datetime='2019-04-08 18', filename='OR_GLM-L2-LCFA_G16_s20190981800000_e20190981800200_c20190981800229.nc')

Realizando o download de todos os arquivos presentes em uma data específica

from awsgoes16.src.awsS3ApiGoes16 import AwsS3ApiGoes16
api_goes = AwsS3ApiGoes16()

api_goes.get_all_files_one_day('2019-04-08')

Exemplos - Via CLI

Listando os arquivos presentes em um bucket (local e remoto)

# LOCAL BUCKET
awsgoes16 list_bucket_files --bucket_name local

# REMOTE BUCKET
awsgoes16 list_bucket_files --bucket_name noaa-goes16

Definindo os parâmetros de coordenadas (latitude e longitude) para filtragem dos dados dos arquivos

awsgoes16 coords --n_lat -22.5 --s_lat -24.0 --w_lon -43.8 --e_lon -43.0
# or
awsgoes16 coords -nl -22.5 -sl -24.0 -wl -43.8 -el -43.0

Fazendo o download de um arquivo específico

awsgoes16 get_file --filename OR_GLM-L2-LCFA_G16_s20190981800000_e20190981800200_c20190981800229.nc --date 2019-04-08 --time 18
# or
awsgoes16 get_file -fn OR_GLM-L2-LCFA_G16_s20190981800000_e20190981800200_c20190981800229.nc -d 2019-04-08 -t 18

Realizando o download de todos os arquivos presentes em uma data específica

awsgoes16 get_all_files_one_day --date 2019-04-08 --logs False
# or
awsgoes16 get_all_files_one_day -d 2019-04-08 -l False

Documentação

Você pode encontrar toda a documentação deste projeto dentro da pasta docs.

• Guia Inicial
• Definição de parâmetros
• Métodos