Atualiza documentacao da estrutura OAMRP
This commit is contained in:
Cesa-V
@@ -1,16 +1,17 @@
|
||||
# Documentação Técnica — Arara OARMP
|
||||
# Documentação Técnica — Arara OAMRP
|
||||
|
||||
## O que é
|
||||
|
||||
O Arara OARMP é um projeto para organizar dados e documentos usados no planejamento e acompanhamento operacional do Esquadrão Arara, em Manaus.
|
||||
O Arara OAMRP é um projeto para organizar dados, documentos e modelos usados no planejamento e acompanhamento operacional do Esquadrão Arara, em Manaus.
|
||||
|
||||
O objetivo é construir uma base rastreável para encaixar missões, aeronaves e manutenções, começando pela leitura e estruturação de documentos operacionais e de manutenção.
|
||||
|
||||
Nesta fase inicial, o projeto contém:
|
||||
|
||||
- documentos originais em `raw/`;
|
||||
- scripts e saídas intermediárias em `pre_process/`;
|
||||
- área reservada para dados finais em `processed/`;
|
||||
- documentos originais em `db/raw/`;
|
||||
- scripts e saídas intermediárias em `db/pre_process/`;
|
||||
- área reservada para dados finais em `db/processed/`;
|
||||
- protótipos de otimização e análise em `software/`;
|
||||
- documentação de contexto, autoria, mudanças e rastreabilidade.
|
||||
|
||||
## Fontes de dados
|
||||
@@ -21,32 +22,44 @@ Fonte inicial processada:
|
||||
|
||||
| Arquivo | Conteúdo | Observação |
|
||||
| --- | --- | --- |
|
||||
| `raw/relatorio_ciclo_inspecoes_c105_2805_2026-06-15.pdf` | Relatório de ciclo de inspeções do equipamento | Aeronave C-105, matrícula 2805, relatório de 2026-06-15 |
|
||||
| `db/raw/relatorio_ciclo_inspecoes_c105_2805_2026-06-15.pdf` | Relatório de ciclo de inspeções do equipamento | Aeronave C-105, matrícula 2805, relatório de 2026-06-15 |
|
||||
|
||||
Arquivos originais devem permanecer em `raw/` sem edição direta.
|
||||
Arquivos originais devem permanecer em `db/raw/` sem edição direta.
|
||||
|
||||
## Como funciona
|
||||
|
||||
O fluxo atual é:
|
||||
|
||||
1. Guardar documentos originais em `raw/`.
|
||||
2. Executar scripts de extração e padronização em `pre_process/`.
|
||||
1. Guardar documentos originais em `db/raw/`.
|
||||
2. Executar scripts de extração e padronização em `db/pre_process/`.
|
||||
3. Gerar saídas intermediárias em texto, JSON e CSV.
|
||||
4. Manter campos originais para rastreabilidade.
|
||||
5. Separar campos discretos úteis para cálculo, comparação e planejamento.
|
||||
6. Registrar mudanças relevantes em `LOG.md`.
|
||||
7. Consolidar dados finais em `processed/` quando os critérios de qualidade estiverem definidos.
|
||||
7. Consolidar dados finais em `db/processed/` quando os critérios de qualidade estiverem definidos.
|
||||
8. Desenvolver protótipos e modelos em `software/`, mantendo dados e código separados.
|
||||
|
||||
## Pré-processamento atual
|
||||
|
||||
O script `pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/preprocess_pdf.py` lê o relatório de ciclo de inspeções em PDF e gera:
|
||||
O script `db/pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/preprocess_pdf.py` lê o relatório de ciclo de inspeções em PDF e gera:
|
||||
|
||||
```text
|
||||
pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_texto.txt
|
||||
pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.json
|
||||
pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.csv
|
||||
db/pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_texto.txt
|
||||
db/pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.json
|
||||
db/pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.csv
|
||||
```
|
||||
|
||||
## Modelo OAMRP inicial
|
||||
|
||||
O arquivo `software/oamrp_v1.py` contém um protótipo de modelo MIP em PuLP para o Aircraft Routing do Esquadrão Arara. O modelo usa dados sintéticos/substituíveis de aeronaves e missões e busca maximizar o cumprimento ponderado de missões opcionais.
|
||||
|
||||
Restrições representadas no protótipo:
|
||||
|
||||
- continuidade espacial e temporal por aeronave;
|
||||
- turnaround mínimo entre missões;
|
||||
- limite de horas de célula até a próxima inspeção;
|
||||
- base inicial e horas acumuladas reais de cada aeronave como parâmetros de entrada.
|
||||
|
||||
Campos extraídos e estruturados:
|
||||
|
||||
| Campo | Conteúdo |
|
||||
@@ -97,13 +110,14 @@ Unidades de duração:
|
||||
3. Mudanças no formato do relatório podem exigir ajuste no script.
|
||||
4. A grafia original é preservada, inclusive erros existentes no documento fonte.
|
||||
5. Ainda não há validação cruzada com outros sistemas ou fontes oficiais.
|
||||
6. Ainda não há modelo final em `processed/` para integração completa entre missões, aeronaves e manutenções.
|
||||
6. O modelo em `software/oamrp_v1.py` ainda é protótipo e usa dados de exemplo a substituir por bases reais.
|
||||
7. Ainda não há modelo final em `db/processed/` para integração completa entre missões, aeronaves e manutenções.
|
||||
|
||||
## Oportunidades de melhoria
|
||||
|
||||
| Prioridade | Melhoria |
|
||||
| --- | --- |
|
||||
| Alta | Definir o modelo final de dados em `processed/` |
|
||||
| Alta | Definir o modelo final de dados em `db/processed/` |
|
||||
| Alta | Criar uma tabela mestre de aeronaves |
|
||||
| Alta | Criar uma tabela mestre de missões |
|
||||
| Alta | Definir regras para cálculo de vencimento por horas, meses e pousos |
|
||||
@@ -116,7 +130,7 @@ Unidades de duração:
|
||||
|
||||
Se o pré-processamento falhar, verifique:
|
||||
|
||||
- se o PDF existe em `raw/`;
|
||||
- se o PDF existe em `db/raw/`;
|
||||
- se o nome do arquivo no script corresponde ao arquivo real;
|
||||
- se as bibliotecas Python necessárias estão instaladas;
|
||||
- se o layout do PDF mudou;
|
||||
@@ -125,5 +139,5 @@ Se o pré-processamento falhar, verifique:
|
||||
Para reexecutar o pré-processamento:
|
||||
|
||||
```powershell
|
||||
python pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/preprocess_pdf.py
|
||||
python db/pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15/preprocess_pdf.py
|
||||
```
|
||||
|
||||
@@ -10,16 +10,16 @@
|
||||
|
||||
## Instituição e contexto
|
||||
|
||||
Projeto desenvolvido para apoiar o OARMP do Esquadrão Arara, em Manaus, com organização colaborativa em repositório Git.
|
||||
Projeto desenvolvido para apoiar o OAMRP do Esquadrão Arara, em Manaus, com organização colaborativa em repositório Git.
|
||||
|
||||
## Como contribuir
|
||||
|
||||
Ao modificar ou estender este projeto:
|
||||
|
||||
1. Atualize sua cópia com `git pull` antes de começar.
|
||||
2. Preserve documentos originais em `raw/`.
|
||||
3. Coloque scripts e saídas intermediárias em `pre_process/`.
|
||||
4. Coloque resultados finais e validados em `processed/`.
|
||||
2. Preserve documentos originais em `db/raw/`.
|
||||
3. Coloque scripts e saídas intermediárias em `db/pre_process/`.
|
||||
4. Coloque resultados finais e validados em `db/processed/`.
|
||||
5. Registre mudanças operacionais em `LOG.md`.
|
||||
6. Registre mudanças de versão em `docs/changelog.md` quando houver alteração significativa.
|
||||
7. Identifique o autor usando a tag do colaborador: `VTO`, `GNR` ou `JOM`.
|
||||
@@ -39,6 +39,7 @@ Ao modificar ou estender este projeto:
|
||||
|
||||
| Versão | Autor | Data | Descrição resumida |
|
||||
| --- | --- | --- | --- |
|
||||
| v0.2 | VTO | 2026-06 | Reorganização dos dados em `db/`, criação de `software/` e inclusão do protótipo MIP `oamrp_v1.py` |
|
||||
| v0.1 | VTO | 2026-06 | Estrutura inicial, documentação, pré-processamento do primeiro relatório de inspeções e migração para o repositório `arara_oarmp` |
|
||||
|
||||
Contribuidores futuros devem adicionar uma linha nesta tabela e criar a entrada correspondente em `docs/changelog.md`.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Changelog
|
||||
|
||||
Todas as versões significativas do Arara OARMP devem ser registradas aqui. O `LOG.md` guarda o diário operacional detalhado; este arquivo resume mudanças por versão.
|
||||
Todas as versões significativas do Arara OAMRP devem ser registradas aqui. O `LOG.md` guarda o diário operacional detalhado; este arquivo resume mudanças por versão.
|
||||
|
||||
Formato:
|
||||
|
||||
@@ -14,6 +14,22 @@ Formato:
|
||||
|
||||
---
|
||||
|
||||
## v0.2 — VTO — 2026-06
|
||||
|
||||
### Adicionado
|
||||
|
||||
- Diretório `software/` com o primeiro protótipo `software/oamrp_v1.py`.
|
||||
- Modelo MIP compacto em PuLP para atribuição de aeronaves a missões opcionais.
|
||||
- Regras de `.gitignore` para caches Python.
|
||||
|
||||
### Alterado
|
||||
|
||||
- Estrutura de dados reorganizada para `db/raw/`, `db/pre_process/` e `db/processed/`.
|
||||
- Documentação atualizada para refletir a separação entre dados (`db/`) e modelos (`software/`).
|
||||
- Nome técnico do projeto padronizado como Arara OAMRP nos documentos principais.
|
||||
|
||||
---
|
||||
|
||||
## v0.1 — VTO — 2026-06
|
||||
|
||||
### Adicionado
|
||||
|
||||
Reference in New Issue
Block a user