Como Usar

Definição

Definição dos padrões de uso da biblioteca para obtenção e análise de dados.

Resumo

Nesta seção demonstramos o uso principal e direcionado do nosso pacote de dados, com trechos de código para agilizar a integração. Abaixo segue o exemplo de importação após a instalação e sua explicação.

import NPHClient
from NPHClient import get_stations
      
apiKey = 'API_KEY'
client = NPHClient(apiKey)

estacoes = client.get_stations()

Entendendo o fluxo:

Linhas 1-2Importação da classe principal NPHClient e dos métodos utilitários necessários para consultar o banco de dados.
Linha 4Definição da chave de API (enviada ao seu e-mail). Ela é essencial para autenticar sua sessão e validar suas permissões de acesso.
Linha 5Inicialização do objeto client. Esta instância gerencia a conexão e permite realizar requisições sequenciais de forma simplificada.
Linha 7Recuperação dos dados. A variável estacoes receberá diretamente um DataFrame do pandas contendo todas as informações disponíveis.

Aplicações

Utilizando a nossa biblioteca você recebe dados reais que são atualizados a todo momento e validados por profissionais da área para garantir a confiabilidade da informação.

Receba informações de diversas variáveis ambientais medidas por órgãos oficiais. Utilizando o banco de medições você tem acesso a dados em tempo real.

from nph_client import NPHClient
from datetime import timedelta

apiKey = 'API_KEY'
client = NPHClient(apiKey)

stations = [351]
startDate = '2024-10-11'
endDate = '2024-10-20'

df_measurements = client.get_measurements(
    stations=stations,
    start_date=startDate,
    end_date=endDate,
    time_offset=timedelta(hours=-3)
)

Aqui o retorno é um DataFrame com a série temporal da estação selecionada.

Aplique esses dados no plotter para melhor visualização das informações.

from nph_client.plotting import plot_series, AxisConfig

# 1. Configuração visual simples
config = AxisConfig(
    label="Nível do Mar (m)",
    columns=['Palmas'], # Nome da coluna no DataFrame
    plot_type='scatter',
    min_val=0, 
    max_val=2.5
)

# 2. Geração do gráfico
# 'df_measurements' foi obtido no passo anterior
plot_series(
    df=df_measurements,
    primary_conf=config,
    title="Monitoramento NPH - Ilha das Palmas"
)

Esse bloco retorna uma imagem gerada pela biblioteca matplotlib.

Nas seções dedicadas a medições, previsões e plotter, detalharemos individualmente as funcionalidades de cada módulo.