Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General review and modifs for a better/cleaner code #2

Open
9 of 10 tasks
aboucaud opened this issue Apr 11, 2024 · 2 comments
Open
9 of 10 tasks

General review and modifs for a better/cleaner code #2

aboucaud opened this issue Apr 11, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@aboucaud
Copy link
Collaborator

aboucaud commented Apr 11, 2024

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
@aboucaud aboucaud added the enhancement New feature or request label Apr 11, 2024
Magwos added a commit that referenced this issue May 12, 2024
@Magwos
Copy link
Member

Magwos commented May 12, 2024

Statut le 12 Mai:

  • 4 tâches terminées, commits 60aa06d, 7f28232, df52fcd, 520b160, 9f03e7a, ddefcd5
  • Majuscules retirées des noms des fichiers -> A réordonner en sous-modules, le plan est d'avoir
    • "toolbox" pour statistics, jax_tools, tools, fisher et utils,
    • "foregrounds" pour templates_spv, customized_models, init_mixing_matrix,
    • "noise" pour noisecovar (et tous les outils qui viendront à la suite)
    • peut-être "likelihood" pour jax_sampling_toolbox, harmonic_likelihood_sampling, non_param_sampling (je ne sais pas si les fichiers principaux sont censés être aussi rangés dans des sous-modules)
  • Probablement besoin d'aide pour correctement ordonner le third-party module de fgbuster et camb (pour être sûr que les lazy imports soient correctement mis en place)
  • Tests et tutoriels à rédiger aujourd'hui

@aboucaud
Copy link
Collaborator Author

On pourra regarder ça ensemble la semaine prochaine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants