cmbscipol / micmac Goto Github PK

In French..

• attention imports circulaires
• import * en dehors du __init__.py à proscrire
• manque des listes de méthodes __all__ dans les fichiers
• naming des fichiers
  => refactorer pour simplifier. La tradition est d'utiliser un seul nom et d'eviter les majuscules
  ex harmonic_Fisher_tools.py => fisher.py
• utiliser les imports absolus
  exfrom .mixingmatrix import ... => from micmac.mixingmatrix import ...
• utiliser des sous-modules pour ordonner le code
  ex: jax_Sampling.py + jax_tools.py => jax/sampling.py + jax/tools.py
• utiliser des lazy imports si pas nécessaires au fonctionnement classique (camb)
  from camb import ... dans la définition des fonctions plutot qu'au début du fichier
• utiliser un third-party module pour importer les fonctions de fgbuster
  ex: sous-module third_party contenant la license de fgbuster + le code qui t'intéresse
• docstrings contiennent un mélange entre Google et Numpy style
  => à mettre à jour (copilot ?)
• ajouter quelques tests pour vérifier que le code tourne toujours peut importe les changements
  ex: MCMC et MICMAC_Harm_obj non définis dans Harmonic_likelihood_sampling.py => le code ne marche pas en l'état