jonescompneurolab / hnn-core

Simulation and optimization of neural circuits for MEG/EEG source estimates
https://jonescompneurolab.github.io/hnn-core/
BSD 3-Clause "New" or "Revised" License
54 stars 52 forks source link

[MRG] Dev extras #703

Closed gtdang closed 8 months ago

gtdang commented 8 months ago

This is a small PR to improve the classification & organization of extra dependencies. The key benefits to this change are:

  1. Streamlines developer dependencies install
    • Contributors only need to run pip install -e '.[dev]', to get all the dependencies for joblib, GUI, test, docs generation.
  2. Installation of dependencies for Github runners uses the dependencies specified by the setup file.
    • Prevents discrepancies between package versions specified in the setup file and workflow yml files
    • We don't have to remember to change dependency specifications in multiple files

Note:

To do:

codecov-commenter commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (d3dd255) 91.35% compared to head (5df2214) 91.35%.

:exclamation: Current head 5df2214 differs from pull request most recent head 4657b5c. Consider uploading reports for the commit 4657b5c to get more accurate results

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #703 +/- ## ======================================= Coverage 91.35% 91.35% ======================================= Files 25 25 Lines 4606 4606 ======================================= Hits 4208 4208 Misses 398 398 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ntolley commented 8 months ago

@gtdang this looks great!

Before I forget, you should add this to whats_new.rst, as well as #696 (under bug fix?)

jasmainak commented 8 months ago

@gtdang you should make a branch to your own fork, not to the main repo. For now it's okay, just remember to delete dev-extras branch after the pull request is merged.

gtdang commented 8 months ago

@gtdang this looks great!

Before I forget, you should add this to whats_new.rst, as well as #696 (under bug fix?)

Thanks! Updated with the whats_new.rst with PRs #695 #696 and the current #703

jasmainak commented 8 months ago

@gtdang I enabled auto-merge. Don't forget to delete the dev-extras branch once you are done since it's on upstream

Thanks a lot for your contributions 🙏 🥳