Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Help: "Your first calculation" as a hub with one walkthrough per code, and input/output format pages

Aberta
#264 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
55/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Domínio
documentation

Direção de pesquisa

Start with help/src/first-calculation.md and help/src/ecce-qm-files.md, then review the existing qe-first-calculation walkthrough and related issues #262 and #260. The work covers a hub, six code-specific walkthroughs verified against real runs, and four input/output format pages; it is done when those pages explain the requested steps and ECCE-used formats and link together as described.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Requested by the maintainer (2026-10-10), for later.

1. "Your first calculation" becomes an entry page that leads to one walkthrough per code:

  • Your first ECCE-QM calculation
  • Your first NWChem calculation
  • Your first Gaussian calculation
  • Your first ORCA calculation
  • Your first MOPAC calculation
  • Your first Quantum ESPRESSO calculation (exists: qe-first-calculation)
  • Your first GROMACS calculation (see #262)

Each walkthrough uses a small molecule, a short run on localhost, and what to look at in the viewer. Each is checked step by step against a real run of that code, as the QE page was. The current first-calculation.md keeps the steps common to all codes (project, Builder, Calculation Editor, Launcher, Viewer), and the per-code pages link back to it.

2. Input and output format pages:

  • The ECCE-QM walkthrough links to the existing ECCE-QM input and output files.
  • Matching pages for NWChem, ORCA, MOPAC and Gaussian: what ECCE writes into the input for each Calculation Editor setting, which output sections ECCE reads (energies, geometry, orbitals, frequencies), and what an output needs to contain to be imported. Cite each code's own manual for the full format; describe only what ECCE uses.

Related: #262 (GROMACS walkthrough), #260.

Linguagem predominante
C
Estrelas
10
Forks
8
Merge médio
21min
PRs com merge (30d)
1

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de FriendsofECCE/ECCE

Todas as issues de FriendsofECCE/ECCE

Issues semelhantes

Mais issues de C

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.