// BrUMaRe · tutorial

Guide complet de BrUMaRe

Tout ce que fait l’outil, étape par étape : du calcul CASTEP aux figures et tableaux de l’article, du mémoire ou de la thèse. Avec les formules utilisées, les bonnes pratiques et comment citer.

1. Vue d’ensemble

BrUMaRe lit les sorties de CASTEP [1], VASP et SIESTA et produit, pour tout matériau et tout atome :

  • la structure de bandes, la DOS et la PDOS, avec spin up et down ;
  • les bandes projetées par orbitale ;
  • l’analyse de la structure locale des défauts (lacune, substitutionnel ou interstitiel) et de la distorsion qu’ils provoquent ;
  • la thermodynamique de formation et de désorption de l’hydrogène ;
  • la densité de charge totale et polarisée, en 3D, en 2D et en profils ;
  • la comparaison côte à côte de plusieurs calculs.

Deux modes d’utilisation font la même analyse :

Site (navigateur)Script Python (cluster)
Utilisationdéposez les fichiers ; réglez tout à l’écranpython3 brumare.py seed
Installationaucune ; les fichiers ne quittent pas votre ordinateurPython 3.8+, numpy et matplotlib
Sortiesfigures PNG/SVG, .dat pour Origin, CHGCAR/XSF pour VESTA, .zip de calculs, rapports .txtles mêmes, dans seed_plots/

Principe central : l’énergie de Fermi n’est jamais recalculée. La valeur utilisée est exactement celle que le programme a écrite, pour chaque spin. Par défaut, les bandes et la DOS gardent leurs énergies d’origine et une ligne tiret-point marque EF ; on peut aussi choisir E − EF.

Modes d’utilisation de BrUMaRe

Le nom BrUMaRe réunit Bruno Macedo et Renata Benedet ; c’est aussi l’acronyme de Brillouin-zone Utilities for Materials Research. Il contient bruma, « brume » en portugais : le nuage électronique que montre le programme. La même analyse existe sous quatre formes :

FormePour quiComment commencer
Page webanalyse interactive, rien à installerouvrez brunohdmacedo.tech/brumare et déposez les fichiers
Application de bureaula même interface que cette page, dans une fenêtre, hors lignepip install "brumare[gui]" puis brumare-gui
Programme Windowsla même application, pour qui n’utilise pas Pythoninstalleur BrUMaRe-Setup.exe sur la page des versions
Ligne de commandecluster et scriptspip install brumare ou brumare.py ; puis brumare mgh2_Fe

L’application de bureau et le .exe ouvrent cette même interface, avec les mêmes onglets et exports, grâce à des bibliothèques intégrées : ils fonctionnent hors ligne. La ligne de commande fait aussi la comparaison (brumare --comparar A,B,C) et le rapport de différence de densité (--field diff). Chaque forme a une partie À propos avec nom, version, auteur, liens et comment citer ; en ligne de commande, utilisez brumare --sobre. L’interface existe en portugais, anglais, espagnol, français, italien et latin (--idioma en ligne de commande).

Codes pris en charge : CASTEP, VASP et SIESTA

BrUMaRe lit les sorties des trois codes et convertit tout dans le même format interne. Bandes, DOS, PDOS, analyse électronique, défauts, thermodynamique, densité et comparaison fonctionnent de la même façon pour les trois, et l’on peut comparer des calculs de codes différents dans un même tableau. L’énergie de Fermi est toujours celle écrite par le code.

CodeFichiersComment les produire
CASTEPseed.bands, .pdos_bin, .castep, .cell, .den_fmtsection 2 de ce tutoriel
VASPle dossier du calcul : vasprun.xml, KPOINTS, CHGCAR (et POSCAR/CONTCAR)LORBIT = 11 (projections), ISPIN = 2 (spin), LCHARG = .TRUE. (densité) ; KPOINTS en mode ligne pour les bandes
SIESTASystemLabel.bands, .EIG, .KP, .PDOS, .STRUCT_OUT ou .XV, .RHO et la sortie .out%block BandLines (ou BandPoints), %block ProjectedDensityOfStates, SaveRho true, Spin polarized

Comment charger :

  • Dans le navigateur : déposez le dossier entier ou utilisez Ouvrir un dossier. Pour VASP, le nom du dossier devient le nom du calcul, car les fichiers ont des noms fixes. Sans dossier, renommez les fichiers en nom.vasprun.xml, nom.KPOINTS, etc.
  • En Python : brumare dossier_vasp/, brumare SystemLabel (SIESTA) ou simplement brumare dans le dossier. Dans l’interface graphique, choisissez le dossier et le calcul dans la liste.

Ce qui change selon le code :

  • VASP :
    • Les projections ne couvrent que les sphères PAW autour des atomes ; la somme de la PDOS reste donc sous la DOS totale. C’est normal.
    • Pour un calcul de bandes non autocohérent, VASP recommande d’utiliser l’EF du calcul autocohérent : chargez les deux et choisissez l’autocohérent dans DOS à partir de.
    • Dans les calculs non colinéaires, seule la partie totale des projections est utilisée.
  • SIESTA :
    • Le .PDOS contient la PDOS déjà calculée par SIESTA, avec les couches n, l et m et l’élargissement choisi dans le .fdf. Elle est utilisée telle quelle.
    • Comme il n’y a pas de poids par bande, il n’y a pas de bandes projetées.
    • Avec le .bands et le .EIG ensemble, les bandes viennent du chemin et la DOS de la grille autocohérente, choisie automatiquement.
  • CASTEP uniquement : la population de Mulliken et le générateur de calculs de référence, qui écrit .cell et .param.

2. Préparer le calcul dans CASTEP

Mots-clés du .param qui produisent tout ce qu’utilise l’outil :

TASK                    : SPECTRAL           ! ou GeometryOptimization, SinglePoint
SPECTRAL_TASK           : BANDSTRUCTURE      ! DOS pour une grille dense
SPIN_POLARIZED          : TRUE
PDOS_CALCULATE_WEIGHTS  : TRUE               ! écrit le .pdos_bin (PDOS et bandes projetées)
POPN_CALCULATE          : TRUE               ! Mulliken et liaisons dans le .castep
WRITE_FORMATTED_DENSITY : TRUE               ! écrit le .den_fmt (densité de charge et de spin)

Le chemin de bandes se place dans le .cell, dans %BLOCK SPECTRAL_KPOINT_PATH [5]. Pour une DOS quantitative, lancez un second calcul avec SPECTRAL_TASK : DOS et une grille Monkhorst–Pack dense [3] ; puis indiquez ce calcul dans DOS à partir de.

FichierUsage
seed.bandsvaleurs propres, EF de chaque spin, poids des points k et maille : bandes, DOS et gap
seed.pdos_binpoids de chaque orbitale dans chaque bande et point k : PDOS et bandes projetées
seed.castepcouches (2p, 3d…), orbitales m, Mulliken [6][7], liaisons, énergies, forces, Z de valence
seed.cellordre des espèces, structure du défaut, base pour générer les références
seed.den_fmt, .cube, CHGCARdensité de charge et de spin

3. Ouvrir les fichiers

  1. Ouvrez l’outil et déposez les fichiers dans la zone en pointillés, ou cliquez sur Ouvrir des fichiers.
  2. Chaque seedname est un calcul. Vous pouvez en charger plusieurs à la fois : le défaut, la structure pure, les références élémentaires et d’autres dopants.
  3. Utilisez × à côté d’un calcul pour le retirer, ou Effacer les données pour recommencer.
  4. Le bouton ☀/☾ change le thème ; le choix vaut aussi pour le portfolio. Le sélecteur de langue est à côté.

4. Bandes

L’onglet Bandes montre le spin up et down superposés, côte à côte ou un seul. Les étiquettes des points de haute symétrie sont détectées pour les réseaux cubique, tétragonal, orthorhombique et hexagonal, ou saisies dans Étiquettes des points k (par exemple G,X,M,G,Z,R,A,Z).

Par défaut, l’axe d’énergie garde les énergies d’origine, avec une ligne tiret-point et la valeur de EF ; la référence peut aussi être l’EF de chaque spin ou un EF commun (E − EF).

5. DOS et PDOS

La DOS est la somme de gaussiennes sur les bandes et les points k, avec l’élargissement σ choisi. La PDOS peut être séparée en cinq niveaux :

NiveauExemple
ÉlémentMg, H, Fe
Orbitale lFe-s, Fe-p, Fe-d
Couche (n, l) du pseudopotentielMg 2p et Mg 3p
Composante mpx, py, pz, dz², dyz, dxz, dx²−y², dxy
t2g/eg et atomes individuelsFe 3d t2g ; Fe1, H25

L’onglet Bandes + DOS place les deux graphiques côte à côte, sur le même axe d’énergie.

6. Bandes projetées

Dans les bandes projetées, la taille de chaque point est proportionnelle au poids de l’orbitale dans cette bande et ce point k. Elles utilisent les projections choisies dans la section Projection, en panneaux séparés ou superposés.

7. Analyse électronique

L’onglet Analyse réunit, pour chaque spin :

  • EF en Ha et en eV ;
  • VBM et CBM, définis par le comptage des électrons (bandes N et N+1), et le gap direct ou indirect avec ses points k ;
  • si EF tombe dans une bande ;
  • N(EF) et la polarisation de spin ;
  • le spin intégré ;
  • les occupations intégrées de la PDOS et le centre de la bande d ;
  • Mulliken par espèce et par atome ;
  • les liaisons du dopant.

8. Éditeur de graphiques

Juste sous chaque figure se trouve le panneau Modifier le graphique : titre, légende et couleurs :

  • Titre et axes : titre, taille, couleur, étiquettes des axes, police et fond (blanc pour publication ou couleurs du site).
  • Légende : position, taille, titre et cadre.
  • Courbes : pour chaque courbe, couleur, nom dans la légende, trait, épaisseur et visibilité ; la ligne de EF se règle aussi ici.
  • Directement sur le graphique : cliquez sur un nom de la légende pour le modifier. Les modifications valent pour tous les onglets.
Éditeur de graphiques
Éditeur de graphiques.

9. Défaut et distorsion

L’onglet Défaut et thermodynamique identifie le défaut de deux façons :

  • Avec la structure pure de référence : chaque atome est apparié à son site, avec conditions périodiques, et le type (lacune, substitutionnel ou interstitiel) est trouvé automatiquement.
  • Sans référence : le défaut est comparé au « massif » de la supermaille elle-même, c’est-à-dire aux atomes éloignés.

Sont calculés :

  • premiers voisins : chaque liaison X–H, par exemple, par rapport à la référence et à Mg–H dans le massif ;
  • liaisons des voisins (par exemple H–Mg) ;
  • indices de distorsion du polyèdre : Baur [9], ECoN [10], élongation quadratique ⟨λ⟩ et variance angulaire σ² [8], volume et angles ;
  • deuxième couche ;
  • avec la référence : le champ de déplacements et le rayon de perturbation.
Onglet Défaut et thermodynamique
Interprétation automatique et tableaux de l’onglet Défaut et thermodynamique.

10. Thermodynamique

Les potentiels chimiques μi sont les énergies par atome des références élémentaires, calculées avec les mêmes paramètres : Mg hcp, Fe bcc et \(\mu_\mathrm{H}=\tfrac12E(\mathrm{H_2})\). Au chargement des .castep de ces références, ils sont remplis automatiquement.

Sont calculés :

  • l’énergie de formation du défaut [16][17] ;
  • l’enthalpie de formation de l’hydrure par mole de H₂, et l’effet du défaut ΔΔH ;
  • la température de désorption par van ’t Hoff, avec ΔS ≈ entropie standard du H₂ gazeux [19] ;
  • l’énergie de retrait d’un H ;
  • la capacité gravimétrique.

Les formules sont à la section 18.

11. Générer les calculs de référence

Avec Générer les calculs de référence à partir de ce .cell, l’outil écrit des .cell et .param avec la même fonctionnelle, coupure, spin, tolérances et pseudopotentiels que votre calcul :

CalculUsage
seed_purostructure pure (à relaxer)
seed_dif_puro_fixohôte pur dans la géométrie du défaut (single point) : Δρ sans dipôles de relaxation
seed_dif_sem_X, seed_dif_so_Xsans le dopant et le dopant seul, dans la même maille (single point) : densité de liaison
seed_semH_perto, seed_semH_longeénergie de retrait de H près et loin du défaut
Mg_hcp, Fe_bcc, H_H2…potentiels chimiques μ

Les supermailles utilisent exactement la même grille k que le défaut. Les références élémentaires utilisent la même densité de points k.

12b. Zone de Brillouin et chemin k

L’onglet Zone de Brillouin calcule la première zone (maille de Wigner–Seitz du réseau réciproque) de tout cristal, trouve les points de haute symétrie, construit le chemin des bandes et produit des entrées prêtes pour le calcul.

  1. Choisissez la structure : un calcul chargé, un exemple (Si, Cu, Fe, Mg, rutile, MgH₂…) ou un réseau saisi à la main (a, b, c, α, β, γ ou les trois vecteurs).
  2. Tolérance de symétrie : avec « Symétriser le réseau », les angles et longueurs presque égaux sont ajustés (0,5° et 0,5 % par défaut), comme dans SeeK-path ; les ajustements sont affichés.
  3. Densité du chemin et Δk : fixent les points par segment et les grilles Monkhorst–Pack suggérées (nᵢ = ⌈|bᵢ|/Δk⌉).
  4. Résultat : zone en 3D, type de réseau, volumes, vecteurs, tableau des points, longueurs des segments et grilles.
  5. Entrées prêtes : CASTEP, VASP (KPOINTS), Quantum ESPRESSO (K_POINTS crystal_b), SIESTA (BandLines) et JSON.
  6. Ligne de commande : brumare --zona-brillouin "fcc 5.431" ou brumare seed --zona-brillouin.

Symétrie et structures. Avec des atomes (calcul chargé, fichier CIF/POSCAR/.cell/XSF/QE/XYZ, numéro COD ou la bibliothèque de 51 matériaux de la littérature), l’onglet identifie le groupe d’espace avec moyo, successeur de spglib : numéro, symboles de Hermann–Mauguin et de Hall, Pearson, système, réseau de Bravais, groupe ponctuel, opérations, inversion et positions de Wyckoff. La zone utilise la maille primitive standardisée, exportable (ainsi que la conventionnelle) en POSCAR, .cell, QE et CIF. Avec la structure, les 14 réseaux de Bravais (les 25 cas de Setyawan et Curtarolo) reçoivent les points et chemins standard, vérifiés avec pymatgen. Ligne de commande : brumare --estrutura fichier.cif.

Les coordonnées fractionnaires sont dans la base réciproque de la maille choisie : utilisez la même maille dans le calcul. Dans une supermaille, les bandes sont repliées ; utilisez la maille primitive pour le chemin standard. Les réseaux cubique, CFC, CC, hexagonal, quadratique et orthorhombique suivent Setyawan et Curtarolo (2010) ; en basse symétrie, SeeK-path (Hinuma et al., 2017) est recommandé.

12. Densité de charge

Dans l’onglet Structure 3D et densité, les grandeurs disponibles sont ρ totale, ρ↑, ρ↓, ρ↑ − ρ↓, |ρ↑ − ρ↓|, ζ = (ρ↑ − ρ↓)/ρ et Δρ.

  • 3D : isosurface réglable, avec atomes, liaisons et maille.
  • 2D : coupes selon un plan.
  • Profil : densité le long d’une liaison, avec le minimum qui approche le point critique de liaison.
  • Charges et moments par atome : partition de Voronoï [12], classique ou radicale [13], et sphère autour du défaut.
  • Pour VESTA [15] : exportez le CHGCAR (format VASP 5 avec les éléments, ρ·V) ou le XSF. Le CHGCAR sert aussi au programme bader [14].

13. Plans (h k l), galerie et maille

  • Indices de la maille de base : l’outil détecte la multiplicité de la supermaille (par exemple 3×3×3 du rutile MgH₂), et les indices sont ceux du matériau.
  • Axes naturels : les axes de la coupe suivent des directions du réseau ; pour (110), horizontal [1̄10] et vertical [001].
  • Section entière : la coupe couvre toute la section de la supermaille, avec le contour de la maille.
  • Balayage : un contrôle déplace le plan le long de la normale.
  • Galerie : montre (110), (1̄10), (001), (100), (010), (101), (011) et (111) côte à côte.
  • Panneau de la maille : masse volumique, capacité en H, coordination, distances par paire et distances dhkl.
Galerie de plans
Galerie de plans passant par le dopant, avec la densité d’un CHGCAR réel.

14. Contribution du défaut : Δρ

Pour ne voir que l’effet du défaut, choisissez Grandeur → contribution du défaut et, dans Soustraire ρ(B), la densité du matériau pur (choisie automatiquement quand son nom contient « puro »). Il y a trois façons, de la plus simple à la plus propre :

  1. ρ(défaut) − ρ(pur relaxé) : inclut l’effet électronique et la relaxation. Des dipôles apparaissent autour des atomes qui ont bougé.
  2. ρ(défaut) − ρ(pur dans la géométrie du défaut), avec seed_dif_puro_fixo : même grille et mêmes positions. Ne montre que le remplacement de l’hôte par le dopant.
  3. ρ(défaut) − ρ(sans le dopant) − ρ(dopant seul), avec B et C : la densité de liaison du dopant, c’est-à-dire la redistribution de charge à la formation des liaisons.

Si les grilles diffèrent, la densité soustraite est rééchantillonnée sur la grille du défaut. L’outil montre :

  • les électrons gagnés et perdus et le bilan ;
  • ∫Δρ dans des sphères autour du dopant ;
  • le transfert de charge par atome (∫Δρ dans la cellule de Voronoï de chaque atome).

Composantes et sens. La différence peut porter sur le total (Δρ), sur chaque spin (Δρ↑, Δρ↓) et sur l’aimantation, Δ(ρ↑ − ρ↓). Dans Sens de la différence, choisissez ρ(défaut) − ρ(pur) ou ρ(pur) − ρ(défaut). Les valeurs positives sont en rouge, les négatives en bleu. Utilisez Limite de l’échelle de couleur ± pour faire ressortir la faible redistribution sur les voisins.

3D autour du défaut. Dans Région 3D, une boîte de ±3 à ±6 Å centrée sur le dopant montre les lobes de Δρ avec les liaisons.

Comparaison et VESTA. Dans l’onglet Comparaison, la différence de chaque défaut par rapport à la référence apparaît en 3D, côte à côte, et en 2D sur le même plan. Le bouton Exporter vers VESTA : tous les calculs crée un .zip avec un dossier par structure. Chaque dossier contient les CHGCAR de ρ, ρ↑, ρ↓, ρ↑ − ρ↓ et des quatre différences, avec les éléments et positions corrects, plus un guide avec la plage de valeurs et la marche à suivre dans VESTA.

Onglet Différence de densité

Un rapport consacré à la redistribution de charge causée par le défaut, avec :

  • indicateurs : ΔN, accumulation, déplétion et charge redistribuée ½∫|Δ| ; rayons de 50 % et 90 % ; points d’accumulation et de déplétion maximales ; dipôle de la redistribution (\(\mathbf p=\int(\mathbf r-\mathbf r_c)\,\Delta\rho\,dV\), en e·Å et en debye) ; variation du moment ;
  • liaisons : ρ minimal de chaque liaison dopant–voisin par rapport à la même liaison de l’hôte dans le pur ;
  • charge par atome dans les deux structures, atomes appariés ;
  • triptyques ρ(pur) | ρ(défaut) | Δρ, en 2D et en 3D ;
  • profil radial ⟨Δ⟩(r) avec la charge cumulée \(\Delta Q(r)=\int_0^r\Delta\rho\,4\pi r'^2dr'\) ;
  • moyennes planaires selon a, b et c ;
  • profil le long de la liaison.

Tout s’exporte vers Origin et VESTA.

15. Comparaison entre calculs

Dans l’onglet Comparaison, cochez les calculs et, s’il y en a une, la structure pure de référence. Vous obtenez :

  • un tableau avec une colonne par calcul : énergies, Ef, ΔH, ΔΔH, Td, EF, gaps, N(EF), polarisation, occupation et moment d, Mulliken, Voronoï, ρ au point critique, coordination, liaisons, ⟨λ⟩, σ², déplacements, ΔV/V, maille et force résiduelle ;
  • graphiques : barres, DOS et PDOS superposées (alignées sur l’EF de chaque calcul), bandes côte à côte, liaisons, déplacements, densité (y compris Δρ par rapport à la référence) sur le même plan et profils.
Comparaison
Graphiques de l’onglet Comparaison (exemple illustratif).

16. Exports

SortieFormatUsage
FiguresPNG, JPG, JXL (JPEG XL), WEBP, SVG (échelle 3 = 300 dpi en 8×6 po)articles, mémoires, thèses
Bandes, DOS/PDOS, poids, coupes, profils, comparaison.dat avec TAB et une ligne d’en-têteOrigin, Excel, gnuplot
DensitéCHGCAR (VASP 5), XSFVESTA, Bader, XCrySDen
Calculs de référence.zip avec .cell, .param, LEIAME, scriptcluster
.bands par spinseed_up.bands, seed_down.bandssumo [18] et autres
Rapports.txtanalyse, défaut, comparaison
Citationbrumare_citacao.bibBrUMaRe, les codes et les méthodes utilisés

Dans Origin : glissez le .dat ; la ligne d’en-tête devient le Long Name de chaque colonne. Pour les bandes, la colonne 1 est X ; tracez les autres en lignes.

17. Script Python

# tout : bandes, DOS/PDOS, analyse, défaut, densité, structure
python3 brumare.py mgh2_Fe -e Mg,H,Fe
# défaut avec référence et thermodynamique
python3 brumare.py mgh2_Fe --ref mgh2_puro --mu "Mg=@Mg_hcp,Fe=@Fe_bcc,H=@H_H2" --h-less mgh2_Fe_semH_perto
# générer les calculs de référence
python3 brumare.py mgh2_Fe --gerar-referencias
# densité : galerie de plans, spin, CHGCAR pour VESTA
python3 brumare.py mgh2_Fe --planes todos --field spin --chgcar
# contribution du défaut et transfert de charge par atome
python3 brumare.py mgh2_Fe --field diff --subtract mgh2_Fe_dif_puro_fixo.den_fmt
# paquet VESTA : ρ, ρ↑, ρ↓, spin et les différences (pur − défaut)
python3 brumare.py mgh2_Fe --vesta --subtract mgh2_puro.den_fmt --diff-sign puro-defeito
# textes (--sobre, citation) en français ; énergies relatives à E_F au lieu des énergies d’origine
python3 brumare.py mgh2_Fe --idioma fr --fermi-ref spin

Utilisez python3 brumare.py -h pour toutes les options.

18. Formules

DOS, avec les poids \(w_k\) et l’élargissement gaussien \(\sigma\) :

\[ g_s(E)=\sum_{k}w_k\sum_n \frac{1}{\sigma\sqrt{2\pi}}\exp\!\left[-\frac{(E-\varepsilon_{nks})^2}{2\sigma^2}\right],\qquad g^{\mathrm{PDOS}}_{s,\alpha}(E)=\sum_k w_k\sum_n p^{\alpha}_{nks}\,\delta_\sigma(E-\varepsilon_{nks}) \]

Gap, avec \(N\) le nombre d’électrons par spin : \(E_g=\min_k\varepsilon_{N+1,k}-\max_k\varepsilon_{N,k}\). Polarisation : \(P=\dfrac{N_\uparrow(E_F)-N_\downarrow(E_F)}{N_\uparrow(E_F)+N_\downarrow(E_F)}\).

Distorsion du polyèdre [9][10][8] :

\[ D=\frac1n\sum_i\frac{|d_i-\bar d|}{\bar d},\qquad \langle\lambda\rangle=\frac1n\sum_i\left(\frac{d_i}{l_0}\right)^2,\qquad \sigma^2=\frac{1}{m-1}\sum_j(\theta_j-\theta_0)^2,\qquad \mathrm{ECoN}=\sum_i e^{\,1-(d_i/d_\mathrm{av})^6} \]

Ici \(l_0\) est la distance centre–sommet du polyèdre régulier de même volume et \(\theta_0\) vaut 90° (octaèdre) ou 109,47° (tétraèdre).

Thermodynamique [16] :

\[ E_f=E_\mathrm{def}-E_\mathrm{pur}-\sum_i n_i\mu_i,\qquad \Delta H_f=\frac{E-\sum_i N_i\mu_i}{N_\mathrm{H}/2},\qquad T_d=\frac{\Delta H}{\Delta S},\qquad \mu_\mathrm{H}=\tfrac12E(\mathrm{H}_2) \]

Dans Ef, \(n_i>0\) indique des atomes ajoutés. ΔH est par mole de H₂ et le ΔS standard vaut 130,7 J/(mol·K).

Densité : CASTEP et VASP écrivent \(\rho V\). BrUMaRe utilise \(\rho\) en e/ų, avec \(\int\rho\,dV=N_e\), \(\zeta=(\rho_\uparrow-\rho_\downarrow)/\rho\) et \(\Delta\rho=\rho_A-\rho_B-\rho_C\). Dans la partition de Voronoï radicale, chaque point va à l’atome qui minimise \(|\mathbf r-\mathbf R_a|^2-r_a^2\), avec les rayons covalents de Cordero [11].

18b. Théorie complète et exemples

Toutes les grandeurs calculées par BrUMaRe, avec l’équation utilisée, et un exemple réel pour chaque code, afin de vérifier que votre résultat a du sens.

Unités et lecture de chaque code

CodeCe qui est luConversion
CASTEP.bands (Ha), .pdos_bin, .castep, .den_fmt (ρV)\(1\,\mathrm{Ha}=27{,}211386\,\mathrm{eV}\); \(1\,\mathrm{Bohr}=0{,}529177\,\text{Å}\)
VASPvasprun.xml (eV), projections PAW, CHGCAR (ρV)énergies déjà en eV; \(\rho=\mathrm{CHGCAR}/V\)
SIESTA.bands, .EIG (eV), .PDOS déjà calculée, .RHO (e/Bohr³)\(\rho\,[\mathrm{e/\text{Å}^3}]=\rho\,[\mathrm{e/Bohr^3}]/0{,}529177^3\)
Quantum ESPRESSOdata-file-schema.xml (Ha; k em \(2\pi/a\))\(\mathbf k_\mathrm{frac}=\mathbf k_\mathrm{cart}\cdot\mathbf A^{T}/(2\pi)\)
ORCAsortie .out : orbitales, énergie, géométrie, chargesmolécule : un seul « point k » ; DOS par gaussiennes sur les niveaux

Bandes, gap et masse effective

Avec \(N_s\) électrons dans le spin \(s\), la dernière bande occupée est la \(N_s\) et la première vide est la \(N_s+1\): \(E_\mathrm{VBM}=\max_k\varepsilon_{N_s,k}\), \(E_\mathrm{CBM}=\min_k\varepsilon_{N_s+1,k}\) e \(E_g=E_\mathrm{CBM}-E_\mathrm{VBM}\). Pour les molécules (ORCA), le même critère donne le gap HOMO–LUMO.

La masse effective provient d’un ajustement parabolique autour de l’extremum, le long du chemin :

\[ E(k)\approx E_0+\frac{\hbar^2 (k-k_0)^2}{2m^*}\quad\Rightarrow\quad \frac{m^*}{m_e}=\frac{\hbar^2}{2m_e\,c_2},\qquad \frac{\hbar^2}{2m_e}=3{,}80998\ \mathrm{eV\,\text{Å}^2} \]

À un sommet (comme Γ), une masse est donnée pour chaque direction du chemin. Elle n’est calculée que si EF est dans le gap et le chemin continu.

DOS, PDOS et niveau de Fermi

\[ g_s(E)=\sum_k w_k\sum_n \frac{e^{-(E-\varepsilon_{nks})^2/2\sigma^2}}{\sigma\sqrt{2\pi}},\qquad N_s(E_F)=g_s(E_F),\qquad P=\frac{N_\uparrow-N_\downarrow}{N_\uparrow+N_\downarrow} \]

EF est toujours la valeur écrite par le code. Par défaut, l’axe montre les énergies d’origine et une ligne tiret-point marque EF ; la fenêtre E min/E max est comptée à partir de EF. La polarisation n’est définie que si \(N_\uparrow+N_\downarrow>0{,}05\) états/eV.

Centre de la bande d : \(\varepsilon_d=\int E\,g_d(E)\,dE\big/\int g_d(E)\,dE\), jusqu’à EF (occupée) ou sur toute la fenêtre.

Zone de Brillouin

La zone est construite par les plans de Bragg k·G = |G|²/2 sur une base réciproque réduite (LLL) ; son volume est vérifié contre (2π)³/V et le type de réseau est reconnu par la forme de la zone.

\[ \mathbf b_1=2\pi\frac{\mathbf a_2\times\mathbf a_3}{V},\quad \mathbf a_i\cdot\mathbf b_j=2\pi\delta_{ij},\quad V_\mathrm{ZB}=\frac{(2\pi)^3}{V},\quad \mathbf k\cdot\mathbf G\le\tfrac12|\mathbf G|^2\ \ \forall\,\mathbf G,\quad k_i^\mathrm{frac}=\frac{\mathbf a_i\cdot\mathbf k}{2\pi},\quad n_i=\left\lceil\frac{|\mathbf b_i|}{\Delta k}\right\rceil \]

Correction du gap (ciseaux)

Les fonctionnelles LDA et GGA (comme PBE) sous-estiment le gap, car le gap de Kohn–Sham n’est pas le gap fondamental : la discontinuité de la dérivée de la fonctionnelle d’échange-corrélation manque et il existe une erreur de délocalisation. BrUMaRe propose une correction en post-traitement : l’opérateur ciseaux décale rigidement les bandes inoccupées (\(n>N_s\)) de \(\Delta\), sans modifier les bandes occupées ni EF. \(\Delta\) peut être donné, calculé à partir d’un gap de référence (expérimental, HSE06 ou GW) ou estimé par le modèle empirique PBE → G0W0 de Morales-García, Valero et Illas (2017), ajusté sur 66 solides.

\[ E_g^\mathrm{DFT}=E_\mathrm{CBM}-E_\mathrm{VBM},\qquad \varepsilon^\mathrm{corr}_{n\mathbf k s}=\varepsilon_{n\mathbf k s}+\Delta\,\Theta(n-N_s),\qquad \Delta_\mathrm{ref}=E_g^\mathrm{ref}-E_g^\mathrm{DFT},\qquad E_g^{G_0W_0}\approx 1{,}358\,E_g^\mathrm{PBE}+0{,}904\ \mathrm{eV} \]

Limites : les ciseaux ne corrigent ni la dispersion des bandes, ni les masses effectives, ni la position des niveaux de défaut vides dans le gap ; le modèle empirique vaut pour PBE (pas LDA), exige un gap non nul et se trompe de quelques dixièmes d’eV (Si : 1,74 eV estimé contre 1,17 eV expérimental). Dans les supermailles avec défaut, préférez le Δ du matériau pur. Pour une vraie correction, refaites le calcul avec HSE06, rSCAN ou DFT+U. En ligne de commande : --gap-corr mvi, --gap-corr ref --gap-ref 1.17 ou --gap-corr tesoura --tesoura 0.5.

Charges : Mulliken, Voronoï et Bader

  • Mulliken (CASTEP et ORCA) : lue dans la sortie du code ; charge \(q_a=Z_a-N_a\).
  • Voronoi: \(N_a=\int_{V_a}\rho\,dV\), avec \(V_a\) les points les plus proches de l’atome \(a\) (ou, dans la version radicale, ceux qui minimisent \(|\mathbf r-\mathbf R_a|^2-r_a^2\)).
  • Bader [14]: chaque point de la grille suit le gradient de ρ jusqu’à un maximum (algorithme sur grille de Henkelman) ; les bassins aboutissant au même atome donnent \(N_a\). Moment magnétique : \(m_a=\int_{V_a}(\rho_\uparrow-\rho_\downarrow)\,dV\) en μB. En ligne de commande, les frontières des bassins sont affinées par la méthode near-grid (Tang, Sanville et Henkelman, 2009), qui suit le vrai gradient de ρ et supprime le biais de la grille ; le résultat diffère de l’implémentation de référence (pybader) de moins de 0,001 e par atome en moyenne.

Défaut, distorsion et thermodynamique

\[ E_f=E_\mathrm{def}-E_\mathrm{puro}-\sum_i n_i\mu_i,\qquad \Delta H=\frac{E-\sum_iN_i\mu_i}{N_\mathrm H/2},\qquad T_d=\frac{\Delta H}{\Delta S},\qquad \langle\lambda\rangle=\frac1n\sum_i\Big(\frac{d_i}{l_0}\Big)^2 \]

Densité et différence de densité

\[ \Delta\rho=\rho_\mathrm{def}-\rho_\mathrm{ref}\ [-\rho_C],\qquad Q_\mathrm{red}=\tfrac12\!\int|\Delta\rho|\,dV,\qquad \mathbf p=\int(\mathbf r-\mathbf r_c)\Delta\rho\,dV,\qquad \Delta Q(r)=\int_0^r\overline{\Delta\rho}\,4\pi r'^2dr' \]

Exemples réels (un par code)

Résultats obtenus avec de vrais fichiers de sortie ; utilisez-les pour vérifier l’installation.

Code et systèmeCommandeRésultat
CASTEP · MgH₂:Fe (supermaille de 162 atomes, spin)brumare mgh2_Fe -e Mg,H,FeEF = 1,837 eV; gap total 1,394 eV, indirect M→R; Fe–H 1,649–1,653 Å
VASP · Si (bandes en mode ligne)brumare Si_bands/gap 0,614 eV indirect (Γ→près de X); m*e = 0,94 me; m*h(Γ) = 0,32 me
VASP · Fe₂O₃ ferromagnétique (LDA+U)brumare FeO_ldau/56 électrons ↑ et 36 ↓ : moment 20 μB (4 Fe³⁺ haut spin)
SIESTA · SrTiO₃brumare SrTiO3gap 2,25 eV indirect R→Γ ; O 2p dans la valence ; Ti 3d t2g/eg dans la conduction; ∫ρ = 40,000 e
Quantum ESPRESSO · Sibrumare dossier_avec_xml/gap 1,32 eV entre les 2 points k du test (grille grossière)
ORCA · divinylbenzène (molécule)brumare dvb_sp.outgap HOMO–LUMO 5,18 eV ; charges de Mulliken et Löwdin
Comparaison entre codesbrumare --comparar mgh2_Fe,Si_bands/,SrTiO3tableau comparacao.dat, DOS superposées, bandes côte à côte et comparacao_citacao.bib

19. Précautions et limites

  • La DOS du chemin de bandes n’est qu’illustrative ; pour des valeurs, utilisez une grille dense.
  • Le gap et les bords ne viennent que des points k du chemin.
  • Les composantes m et t2g/eg sont dans les axes cartésiens de la maille.
  • Les énergies à 0 K n’ont pas d’énergie de point zéro ; Td est une estimation pour comparer des tendances.
  • Mêmes paramètres : ne comparez que des calculs avec la même fonctionnelle, coupure, pseudopotentiels et U.
  • Les charges de Voronoï sont des estimations ; pour des valeurs quantitatives, utilisez Bader.
  • Δρ avec des grilles ou volumes différents est rééchantillonnée. L’idéal est d’avoir des grilles identiques, avec dif_puro_fixo.

20. Comment citer

Si BrUMaRe a aidé votre travail, citez le logiciel et, le cas échéant, le mémoire et la thèse de l’auteur. Citez aussi CASTEP [1] (ou VASP ou SIESTA) et VESTA [15], si vous l’avez utilisé. Le bouton Citer (.bib) de l’outil télécharge un .bib avec exactement ce que vous avez utilisé. Téléchargements : brumare.bib · CITATION.cff · tutoriel en PDF · source LaTeX (portugais).

ABNT (NBR 6023)

Les citations sont conservées dans leur langue d’origine, telles que publiées.

MACEDO, B. H. D. BrUMaRe: Brillouin-zone Utilities for Materials Research — análise de estrutura de bandas, DOS, PDOS, densidade de carga, defeitos e termodinâmica a partir de cálculos CASTEP, VASP e SIESTA. Versão 1.3.0. Foz do Iguaçu, 2026. Software. Disponível em: https://brunohdmacedo.tech/brumare/. Acesso em: [dia mês ano].
MACEDO, B. H. D. Influência de defeitos substitucionais nas propriedades estruturais, eletrônicas, termodinâmicas e de armazenamento do hidreto MgH₂: uma abordagem ab initio. 2025. Trabalho de Conclusão de Curso (Bacharelado em Engenharia Física) – Universidade Federal da Integração Latino-Americana, Foz do Iguaçu, 2025. Disponível em: https://dspace.unila.edu.br/items/8db3836e-925d-422f-9cd2-6ff3f9f02080.
MACEDO, B. H. D.; ZALEWSKI, W. Dataset_Machine_Learning_Exoplanets_2024. Mendeley Data, v. 3, 2024. DOI: 10.17632/wctcv34962.3.
MACEDO, B. H. D.; ZALEWSKI, W. Processamento automático de curvas de luz para a identificação de exoplanetas por meio de algoritmos de aprendizado de máquina. Revista Brasileira de Iniciação Científica, v. 11, e024021, 2024.
MACEDO, B. H. D. Influência de defeitos substitucionais no MgH₂: uma abordagem ab initio. Dissertação (Mestrado em Física Aplicada) – Programa de Pós-Graduação em Física Aplicada, Universidade Federal da Integração Latino-Americana, Foz do Iguaçu, [ano]. [em andamento: confira o título definitivo]

BibTeX

@misc{macedo2026brumare,
  author       = {Macedo, Bruno Henrique Dourado},
  title        = {{BrUMaRe}: {Brillouin-zone Utilities for Materials Research} --- análise de estrutura de bandas, {DOS}, {PDOS}, densidade de carga, defeitos e termodinâmica a partir de cálculos {CASTEP}, {VASP} e {SIESTA}},
  year         = {2026},
  version      = {1.3.0},
  howpublished = {\url{https://brunohdmacedo.tech/brumare/}},
  note         = {Código-fonte: \url{https://github.com/brunohdmacedo/brumare}}
}
@misc{macedo2025tcc,
  author       = {Macedo, Bruno Henrique Dourado},
  title        = {Influência de defeitos substitucionais nas propriedades estruturais, eletrônicas, termodinâmicas e de armazenamento do hidreto {MgH$_2$}: uma abordagem \textit{ab initio}},
  year         = {2025},
  howpublished = {Trabalho de Conclusão de Curso (Bacharelado em Engenharia Física), UNILA},
  url          = {https://dspace.unila.edu.br/items/8db3836e-925d-422f-9cd2-6ff3f9f02080},
  note         = {Orientador: Rodrigo Santos da Lapa}
}

@misc{macedo2024dataset,
  author = {Macedo, Bruno Henrique Dourado and Zalewski, Willian},
  title  = {Dataset\_Machine\_Learning\_Exoplanets\_2024},
  year   = {2024},
  howpublished = {Mendeley Data, v3},
  doi    = {10.17632/wctcv34962.3}
}
@mastersthesis{macedo2027dissertacao,
  author  = {Macedo, Bruno Henrique Dourado},
  title   = {Influência de defeitos substitucionais no {MgH$_2$}: uma abordagem \textit{ab initio}},
  school  = {PPGFISA, Universidade Federal da Integração Latino-Americana (UNILA)},
  address = {Foz do Iguaçu, PR},
  year    = {2027},
  type    = {Dissertação (Mestrado em Física Aplicada)},
  note    = {Orientador: J. R. C. Salgado; coorientador: R. S. da Lapa. Bolsa CNPq}
}

O TCC, o artigo e a base de dados foram conferidos no DSpace UNILA, na RBIC e no Mendeley Data; o título da dissertação (em andamento) ainda deve ser conferido. No GitHub, o arquivo CITATION.cff faz aparecer o botão “Cite this repository”.

21. Références

  1. CLARK, S. J. et al. First principles methods using CASTEP. Z. Kristallogr., v. 220, p. 567–570, 2005. doi:10.1524/zkri.220.5.567.65075
  2. PERDEW, J. P.; BURKE, K.; ERNZERHOF, M. Generalized gradient approximation made simple. Phys. Rev. Lett., v. 77, p. 3865, 1996. doi:10.1103/PhysRevLett.77.3865
  3. MONKHORST, H. J.; PACK, J. D. Special points for Brillouin-zone integrations. Phys. Rev. B, v. 13, p. 5188, 1976. doi:10.1103/PhysRevB.13.5188
  4. SAKINTUNA, B.; LAMARI-DARKRIM, F.; HIRSCHER, M. Metal hydride materials for solid hydrogen storage: a review. Int. J. Hydrogen Energy, v. 32, p. 1121–1140, 2007. doi:10.1016/j.ijhydene.2006.11.022
  5. SETYAWAN, W.; CURTAROLO, S. High-throughput electronic band structure calculations. Comput. Mater. Sci., v. 49, p. 299–312, 2010. doi:10.1016/j.commatsci.2010.05.010
  6. MULLIKEN, R. S. Electronic population analysis on LCAO–MO molecular wave functions. I. J. Chem. Phys., v. 23, p. 1833, 1955. doi:10.1063/1.1740588
  7. SEGALL, M. D. et al. Population analysis of plane-wave electronic structure calculations of bulk materials. Phys. Rev. B, v. 54, p. 16317, 1996. doi:10.1103/PhysRevB.54.16317
  8. ROBINSON, K.; GIBBS, G. V.; RIBBE, P. H. Quadratic elongation. Science, v. 172, p. 567–570, 1971. doi:10.1126/science.172.3983.567
  9. BAUR, W. H. The geometry of polyhedral distortions. Acta Cryst. B, v. 30, p. 1195–1215, 1974. doi:10.1107/S0567740874004560
  10. HOPPE, R. Effective coordination numbers (ECoN) and mean fictive ionic radii (MEFIR). Z. Kristallogr., v. 150, p. 23–52, 1979. doi:10.1524/zkri.1979.150.1-4.23
  11. CORDERO, B. et al. Covalent radii revisited. Dalton Trans., p. 2832–2838, 2008. doi:10.1039/B801115J
  12. VORONOI, G. Nouvelles applications des paramètres continus à la théorie des formes quadratiques. J. Reine Angew. Math., v. 134, p. 198–287, 1908. doi:10.1515/crll.1908.134.198
  13. GELLATLY, B. J.; FINNEY, J. L. The radical alternative to the Voronoi polyhedron. J. Non-Cryst. Solids, v. 50, p. 313–329, 1982. doi:10.1016/0022-3093(82)90093-X
  14. HENKELMAN, G.; ARNALDSSON, A.; JÓNSSON, H. A fast and robust algorithm for Bader decomposition of charge density. Comput. Mater. Sci., v. 36, p. 354–360, 2006. doi:10.1016/j.commatsci.2005.04.010
  15. MOMMA, K.; IZUMI, F. VESTA 3 for three-dimensional visualization of crystal, volumetric and morphology data. J. Appl. Cryst., v. 44, p. 1272–1276, 2011. doi:10.1107/S0021889811038970
  16. FREYSOLDT, C. et al. First-principles calculations for point defects in solids. Rev. Mod. Phys., v. 86, p. 253–305, 2014. doi:10.1103/RevModPhys.86.253
  17. VAN DE WALLE, C. G.; NEUGEBAUER, J. First-principles calculations for defects and impurities. J. Appl. Phys., v. 95, p. 3851, 2004. doi:10.1063/1.1682673
  18. GANOSE, A. M.; JACKSON, A. J.; SCANLON, D. O. sumo. J. Open Source Softw., v. 3, p. 717, 2018. doi:10.21105/joss.00717
  19. CHASE, M. W. NIST-JANAF Thermochemical Tables. 4. ed. J. Phys. Chem. Ref. Data, Monograph 9, 1998.