Projeto LCEC-UNB – Modelo de Repositório

Este repositório serve como modelo base para novos projetos de código científico desenvolvidos no Laboratório de Computação Científica em Escoamentos Complexos (LCEC-UNB).

🧠 Estrutura de novos repositórios

Novos repositórios devem obedecer à estrutura abaixo.

nome_do_repositorio/ ├── README.md ├── LICENSE ├── .gitignore ├── src/ ├── docs/ └── examples/

• src/ → códigos-fonte do projeto
• examples/ → casos de teste e exemplos de simulação
• docs/ → documentação, artigos e anotações técnicas

Um bom modelo de gitignore para usarmos em projetos científicos é dado abaixo (comece com ele no seu repositório):

# Arquivos comuns a projetos científicos
*.o
*.mod
*.exe
__pycache__/
*.log
*.dat
*.tmp
*.out

🧭 Guia de Boas Práticas – Como escrever um bom README.md

Um bom README.md é o cartão de visita do seu projeto científico.
Ele deve permitir que qualquer pessoa (inclusive você, no futuro!) entenda rapidamente
o que o código faz, como rodar, como contribuir e quais resultados esperar.

O arquivo README.md deve ser completo e descrever de maneira clara e interessante o que o programa faz, como faz, para que serve, qual o contexto de sua criação, artigos científicos vinculados ao programa e referências bibliográficas. O README.md pode conter imagens e equações científicas usando sintaxe LaTeX. Apenas garanta que essas equações fiquem visíveis ao subir o README.md para o GitHuB. As imagens ilustrativas contidas no README.md podem ser armazenadas dentro da pasta examples e de preferência em formato PNG. Para documentações muito extensas, você pode criar seções e um sumário no início do arquivo README.md (ver exemplos no repositório do simmsus: https://github.com/lcec-unb/simmsus).

Abaixo estão as boas práticas recomendadas pelo LCEC-UNB.

---

📘 Estrutura mínima recomendada

# Nome do Projeto
Breve descrição do objetivo e contexto científico do projeto.

## 🎯 Objetivo
Explique em 2–3 frases o que o programa resolve ou investiga.
Exemplo: “Simula o campo de temperatura em um tecido biológico sujeito a aquecimento magnético.”

## ⚙️ Estrutura de Pastas
Descreva como o projeto está organizado:
- `src/` – códigos-fonte principais
- `examples/` – casos de teste e exemplos de simulação
- `docs/` – relatórios, artigos, anotações e resultados
- `input/` (opcional) – arquivos de entrada
- `output/` (opcional) – resultados gerados

## 🚀 Execução
Explique como compilar e rodar:
```bash
make
./programa.exe < input.dat > output.log

Inclua também dependências (por exemplo, “necessita do compilador gfortran ou ifx”).

📊 Exemplos de Saída

Mostre exemplos reais: gráficos, tabelas ou prints de terminal. Use figuras do diretório examples/ ou docs/.

🧪 Metodologia / Modelos Matemáticos

Descreva brevemente o modelo físico ou matemático usado. Se possível, cite referências bibliográficas (artigos, dissertações, teses).

👥 Autoria e Responsável

• Autor principal: Nome do aluno (ano)
• Orientador: Prof. Rafael Gabler Gontijo
• Laboratório: LCEC-UNB

📜 Licença

Indique a licença usada (ex: MIT).

📚 Referências

Liste até 3 referências que embasam o trabalho (artigos, livros, relatórios).

💡 Boas práticas

• Use Markdown com títulos (#, ##, ###), listas e blocos de código.
• Prefira explicações curtas e claras.
• Inclua imagens e figuras salvas em docs/ usando:

  ![Descrição da imagem](docs/figura1.png)

• Evite incluir arquivos binários pesados no repositório.
• Atualize o README.md sempre que o projeto mudar.

---

🔧 Dicas extras

• Use emojis para deixar o README mais visual (🎯 ⚙️ 📊 💡).
• Se o projeto gerar figuras de resultados, mostre uma imagem de exemplo.
• Se houver publicação associada, inclua o DOI ou link para o artigo.
• Atualize o README a cada etapa relevante (nova versão, caso de teste, release).

---

📘 Este guia é parte do padrão oficial de documentação dos projetos do LCEC-UNB.
Todos os novos repositórios devem incluir um README.md seguindo estas orientações.

👥 Contato

Coordenador: Prof. Rafael Gabler Gontijo
Organização: LCEC-UNB no GitHub