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
53 stars 52 forks source link

[MRG] DOC: add JOSS badge and CITATION.cff #700

Closed rythorpe closed 8 months ago

rythorpe commented 8 months ago

@jasmainak do you think we need a citation statement in the README as well, or is the badge and "Cite this repository" tab Github adds with CITATION.cff adequate?

jasmainak commented 8 months ago

You won’t see the github tab on the website, so I think a redundancy in the readme won’t hurt!

Sent from my iPhone

On Tue 19 Dec 2023 at 14:17, Ryan Thorpe @.***> wrote:

@jasmainak https://github.com/jasmainak do you think we need a citation statement in the README as well, or is the badge and "Cite this repository" tab Github adds with CITATION.cff adequate?

— Reply to this email directly, view it on GitHub https://github.com/jonescompneurolab/hnn-core/pull/700#issuecomment-1863341536, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADY6FIRTB7JAOJ5C5RXJSNLYKHR3DAVCNFSM6AAAAABA3VMW4WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNRTGM2DCNJTGY . You are receiving this because you were mentioned.Message ID: @.***>

codecov-commenter commented 8 months ago

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (1216038) 91.34% compared to head (3c1531b) 91.34%. Report is 2 commits behind head on master.

:exclamation: Current head 3c1531b differs from pull request most recent head ffa287a. Consider uploading reports for the commit ffa287a to get more accurate results

Files Patch % Lines
hnn_core/gui/_viz_manager.py 50.00% 1 Missing :warning:

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #700 +/- ## ======================================= Coverage 91.34% 91.34% ======================================= Files 25 25 Lines 4599 4599 ======================================= Hits 4201 4201 Misses 398 398 ```

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

rythorpe commented 8 months ago

Here's how the citation section looks in the compiled README. If it looks good, feel free to merge @jasmainak.

image

jasmainak commented 8 months ago

Looks good, thanks @rythorpe !!