Skip to content

Estruturação do repositório e scaffold de reprodutibilidade para modelos energéticos (v0.1)#2

Draft
leticiasdrummond wants to merge 1 commit into
mainfrom
codex/create-structured-project-files
Draft

Estruturação do repositório e scaffold de reprodutibilidade para modelos energéticos (v0.1)#2
leticiasdrummond wants to merge 1 commit into
mainfrom
codex/create-structured-project-files

Conversation

@leticiasdrummond

Copy link
Copy Markdown
Owner

Motivation

  • Estruturar o repositório para reprodutibilidade científica dos modelos MILP de energia, separando prototipação em notebooks do código executável e das configurações de cenário.
  • Capturar decisões e metadados essenciais (assunções, dicionário de dados, changelog e ambiente) para rastreabilidade e versão inicial v0.1.
  • Fornecer scripts e templates que permitam executar cenários de forma automatizada e exportar código dos notebooks para auditoria.

Description

  • Adiciona documentação base: README.md, changelog.md, assumptions.md, data_dictionary.md e ENVIRONMENT.md com visão do projeto, versão e práticas de rastreabilidade.
  • Cria estrutura de pastas e artefatos de projeto (notebooks/, src/, configs/, data/{raw,interim,processed}, results/, docs/, scripts/) e move os notebooks originais para notebooks/.
  • Implementa pipeline executável: src/model.py (formulação MILP em Pyomo) e src/run_scenario.py (carrega YAML, valida, resolve e exporta resultados), além de cenários configs/caso_base.yaml e configs/caso_modificado.yaml.
  • Adiciona automação e utilitários: run_all.sh, Makefile, requirements.txt, .gitignore, e scripts/extract_notebook_code.py que gera src/notebook_exports/ filtrando comandos sensíveis; incluiu também arquivos .gitkeep para pastas vazias.

Testing

  • python -m py_compile src/model.py src/run_scenario.py scripts/extract_notebook_code.py foi executado com sucesso e sem erros de sintaxe.
  • scripts/extract_notebook_code.py foi executado com sucesso e gerou arquivos em src/notebook_exports/ conforme esperado.
  • pip install -r requirements.txt falhou devido a bloqueio de rede/proxy (403 Forbidden) no ambiente, impedindo a instalação automática das dependências (rede/índice inacessível).
  • python src/run_scenario.py --help falhou em tempo de execução devido à ausência do pacote pyomo no ambiente atual, consequência da falha na etapa de instalação de dependências.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant