Introdução

Esta ferramenta computacional foi desenvolvida especificamente para apoiar profissionais e pesquisadores em hidrologia do CENSIPAM na detecção automatizada, análise detalhada e adequação supervisionada de inconsistências em séries temporais de dados hidrológicos. Em um contexto onde a qualidade dos dados é fundamental para a gestão eficaz de recursos hídricos na Amazônia Legal, esta solução oferece recursos técnicos avançados para garantir a confiabilidade das informações utilizadas.

Funcionalidades principais

O sistema integra algoritmos avançados baseados em abordagens numéricas e estatísticas, combinados com ferramentas de visualização interativa, permitindo uma análise abrangente e detalhada dos dados hidrológicos. A interface intuitiva foi projetada para facilitar tanto análises exploratórias quanto processos de validação sistemática, atendendo às necessidades de usuários com diferentes níveis de expertise técnica.

Estrutura da Documentação Esta documentação está organizada em três seções principais, facilmente acessíveis através da barra de navegação lateral:

Manual de usuário

Fornece instruções detalhadas para a operação da ferramenta, incluindo procedimentos para importação de dados, configuração de parâmetros de análise, interpretação de resultados e exportação de relatórios técnicos.

Manual de desenvolvimento

Apresenta documentação técnica completa para desenvolvedores, abordando a arquitetura do sistema, APIs disponíveis, possibilidades de extensibilidade e diretrizes para contribuições ao projeto.

Manual de Implantação

Oferece um guia completo para instalação e configuração, incluindo requisitos de sistema, procedimentos de setup do ambiente e rotinas de manutenção.

Como Utilizar Esta Documentação

Para otimizar o aproveitamento desta documentação, recomendamos que:

• Novos usuários iniciem pelo Manual do Usuário para familiarização com as funcionalidades básicas e fluxos de trabalho da ferramenta
• Desenvolvedores interessados em contribuir ou personalizar a ferramenta consultem o Manual de Desenvolvimento para compreender a estrutura técnica e as possibilidades de extensão
• Administradores de sistema responsáveis pela implantação utilizem o Manual de Implantação, que fornece todas as informações necessárias para uma instalação bem-sucedida

2. Manual de Usuário: Onde Encontrar Informações sobre o Uso da Ferramenta

Este manual constitui um guia abrangente que documenta todas as funcionalidades da ferramenta, fornecendo orientações detalhadas sobre procedimentos operacionais e recursos disponíveis. Este documento pode ser acessado através da segunda pasta no menu de navegação ou diretamente pelo link: Manual de Usuário.

Estrutura Organizacional das Páginas

O manual está estruturado em seções específicas para otimizar a experiência do usuário:

1. Página Inicial: O que encontrar?

Apresenta explicações detalhadas sobre o processo de autenticação, incluindo a caracterização dos diferentes perfis de usuário autorizados a acessar a plataforma.

2. Fluxograma Operacional

Oferece uma representação visual das operações executáveis no sistema, proporcionando uma compreensão clara e intuitiva do fluxo de trabalho estabelecido.

3. Fluxo de Login

Detalha os procedimentos de autenticação e especifica os critérios de elegibilidade para acesso à ferramenta por diferentes categorias de usuários.

4. Como Selecionar uma Estação

Demonstra os recursos disponíveis para seleção e busca de estações, estabelecendo as bases para posteriores adequações ou atividades de supervisão.

5. Gráficos das Estações: O que Representam e Onde Encontrar

Fornece orientações específicas sobre os diferentes tipos de gráficos associados a cada estação, incluindo metodologias de interpretação e localização para análise eficiente de dados.

6. Adequações: Como Fazer?

Instrui detalhadamente sobre os procedimentos para realização de adequações e correções de dados, estabelecendo protocolos que asseguram a integridade, qualidade e precisão das informações processadas.

7. Manual de Supervisão

Guia especializado destinado a usuários com perfil supervisório, apresentando recursos específicos e funcionalidades avançadas disponíveis para esta categoria profissional.

8. Manual de Administração

Documentação técnica direcionada a usuários com privilégios administrativos, detalhando ferramentas de gestão e configurações avançadas do sistema.

3. Manual de Desenvolvimento: Localização de Informações Técnicas

Este manual constitui a documentação técnica abrangente do projeto, detalhando sua arquitetura e componentes essenciais. Desenvolvido especificamente para orientar desenvolvedores, oferece informações precisas sobre cada elemento do sistema. Este documento pode ser acessado através da terceira pasta no menu de navegação ou diretamente pelo link: Manual de Desenvolvimento.

A documentação está organizada em cinco seções especializadas, cada uma focada em aspectos específicos do sistema:

1. Backend

Abrange toda a documentação relacionada aos serviços de retaguarda: Especificações da API principal, Arquitetura do Backend-API, Processo de extração de dados da ANA e Funcionamento do extrator de dados

2. Banco de Dados

Fornece recursos fundamentais para compreensão da persistência de dados: Diagramas de Entidade-Relacionamento (DER) completos, Dicionário de dados detalhado da aplicação, Mapeamento de estruturas, tabelas e relacionamentos e Documentação essencial para navegação no banco de dados.

3. Frontend

Documenta toda a camada de apresentação e interação: Arquitetura completa do frontend, Estrutura hierárquica de componentes, Estratégias de gerenciamento de estado, Integração com servidor Bokeh para visualizações e Fluxos de dados entre componentes.

4. Keycloak

Apresenta configuração completa do sistema de autenticação: Requisitos técnicos detalhados, Guia passo a passo para configuração local, Instruções para replicação do ambiente e Configurações de autenticação e autorização

5. Métodos Estatísticos

Oferece fundamentação teórica dos processos analíticos: Resumo dos métodos estatísticos implementados, Contextualização das técnicas utilizadas e Referências para aprofundamento técnico

4. Manual de Implantação: Onde Encontrar Informações de Implantação

O Manual de Implantação apresenta de forma detalhada a infraestrutura tecnológica utilizada, os serviços envolvidos no processo e os procedimentos passo a passo necessários para configurar adequadamente e verificar a integridade do ambiente de produção. Este documento pode ser acessado através da quarta pasta no menu de navegação ou diretamente pelo link: Manual de Implantação.