Teses de física: equações, unidades e sanidade com vários arquivos

Notação, siunitx, projetos com vários capítulos, armadilhas de periódicos em duas colunas e hábitos de compilação offline para estudantes de física e astronomia.

Os manuscritos de física carregam mais matemática por página do que os da maioria das áreas. Isso é tranquilo até um capítulo pela metade quebrar a compilação inteira porque um rótulo mudou de lugar, ou até cada coautor inventar uma convenção diferente para vetores em negrito.

Esta é uma configuração prática para capítulos de mestrado e doutorado, notas de colaboração e submissões a periódicos que ainda pedem duas colunas.

Vários arquivos desde o início

Até uma tese curta se beneficia de um arquivo raiz e de inclusões de capítulos:

\documentclass{report} % or the university class
\begin{document}
\include{chapters/intro}
\include{chapters/methods}
\include{chapters/results}
\end{document}

Use \includeonly{chapters/methods} enquanto redige para não recompilar três capítulos só para corrigir uma equação. Detalhes: um arquivo raiz, vários capítulos.

Mantenha as figuras em figures/ch2/ e nomeie as equações com rótulos que levem o capítulo em conta (eq:ch2-hamiltonian) para que as mesclagens não colidam.

Unidades não são texto

Escreva $v = 3.0\,\mathrm{m\,s^{-1}}$ à mão se for preciso, ou carregue o siunitx e use \qty{3.0}{m.s^{-1}}. Os periódicos divergem quanto ao espaçamento e aos espaços finos; escolha um caminho de pacote e mantenha-o. Estilos misturados parecem dois autores que nunca se conheceram.

Em tabelas de valores, os tipos de coluna do siunitx alinham as casas decimais e mantêm consistentes os cabeçalhos de unidades. Não misture m/s e ms^{-1} no mesmo artigo sem uma razão declarada nos métodos.

Dirac, vetores e convenções de negrito

Grupos de física quântica e de matéria condensada muitas vezes precisam da notação de Dirac. Pacotes como o physics ou macros dedicadas para \ket, \bra, \braket são melhores do que combinações improvisadas de colchetes angulares. Grupos de mecânica clássica discutem vetores em negrito versus com seta. Documente a convenção no preâmbulo e recuse exceções improvisadas no meio do capítulo.

Veja notação de Dirac e vetores e símbolos em negrito.

Defina os operadores uma vez (\DeclareMathOperator) para que operadores diferenciais e funções nomeadas não mudem de fonte ao longo do texto.

Numeração e referências cruzadas

Numere as equações que você vai citar; deixe as demais sem número. Uma página de (1)(2)(3)... é mais difícil de ler do que uma narrativa curta com duas linhas marcadas. Use \eqref para equações e rótulos estáveis. A verificação de referências em todo o projeto pega um rótulo apagado antes do orientador.

Teoremas e lemas (se você os usar) devem compartilhar um esquema de numeração claro com o resto do modelo do departamento. Veja também blocos de teorema e de prova.

Armadilhas dos periódicos em duas colunas

As classes da APS, da IOP e similares mudam o comportamento dos flutuantes. Uma figura que parecia boa em article pode se recusar a ficar ao lado do parágrafo que a cita. Compile com a classe real cedo, não no fim de semana antes da submissão.

Padrões que ajudam:

  • largura da figura em torno de 0.45\textwidth ou \columnwidth em duas colunas
  • figuras largas como figure* (muitas vezes só no topo da página)
  • deduções longas em multline / split, ou movidas para um apêndice

Não reduza a fonte das equações até ficar ilegível. Os pareceristas percebem.

Figuras: gráficos e esquemas

Exporte os gráficos como PDF a partir do matplotlib/gnuplot/Root quando puder. PNGs raster são para fotografias e imagens de detectores, com dpi suficiente. Os esquemas podem ser em TikZ ou arte vetorial externa; mantenha o código-fonte no repositório. Corte o espaço em branco antes do \includegraphics.

Offline quando a rede do laboratório cai

Linhas de luz e salas limpas não são conhecidas por ter Wi-Fi estável. O Oleafly (abre em uma nova guia) traz os compiladores e mantém o SyncTeX, a área de trabalho do PDF e a prévia matemática locais. Todo projeto é um Git de verdade com pontos de verificação automáticos, então uma edição ruim de equação está a uma restauração de distância. O PDF continua sendo gerado quando um editor no navegador não carrega.

Você pode montar uma pilha offline parecida com o TeX Live, um visualizador de PDF e o Git, à mão. De qualquer forma, a tese não deve depender de um portal cativo para recompilar o capítulo três.

Colaboração

Atribua os capítulos a autores específicos quando possível. Compartilhe uma folha de notação. Rode compilações do documento completo toda semana para que as referências entre capítulos falhem cedo. Remoto Git privado para resultados inéditos; público só quando a política da colaboração permitir.

Apêndices e material suplementar

Deduções longas e gráficos extras pertencem a um apêndice ou a um PDF suplementar separado quando o periódico tem duas colunas e limite de páginas. Faça referências cruzadas explícitas (“ver Apêndice B”) com rótulos de verdade. Não presuma que o parecerista vai abrir um zip de figuras soltas e sem legendas.

Quando o orientador edita no papel

Aplique as anotações ao código-fonte TeX no mesmo dia, se puder. Pilhas de papel ficam desatualizadas. Se dois orientadores marcam notações conflitantes, atualize a folha do preâmbulo e envie um PDF de uma página com a notação, para que a discussão não seja reaberta a cada rascunho.

Antes da submissão

Folha de notação completa, vetores e bras/kets consistentes, unidades por um único sistema (siunitx ou um estilo manual combinado). Os capítulos devem ser incluídos sem problemas, com \ref/\eqref resolvidos. Compile a classe real do periódico ou da tese sem surpresas de fontes. As figuras atendem às regras de dpi e de cor; as legendas se sustentam sozinhas. Arquive o código-fonte e o PDF com o hash do commit da versão submetida.

Escrever física já é difícil o bastante. A cadeia de ferramentas deve continuar sem graça.

Todas as postagens