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

release 0.2 #365

Closed jasmainak closed 1 year ago

jasmainak commented 3 years ago

hi guys,

I think it's time for another release. 3 month cycles are usually recommended but 6 months is also fine. I'd like to get it out before getting busy with next grant cycle. I'm thinking that these are the goals for this release:

Priorities

Connectivity API

Bump to 0.3

anything else? It's going to be a bombshell of a release!

cjayb commented 3 years ago

Made some edits/proposals. Perhaps need to prioritise... ;)

ntolley commented 3 years ago

I'd be interested in taking up the calcium dynamics. I am already laying the groundwork with #348 which is nearing completion (just need to take an afternoon and play with the simulations).

I have also made a lot of progress on what is likely the most difficult task remaining for the connectivity API #367.

The remaining stuff for more verbose warnings when adding connections might be a good exercise for @kenloi as a more intermediate level PR. This would involve creating a list of what is considered "valid connections" (example, pyramidal cells shouldn't make GABA synapses), and referencing that list from net.add_connection.

jasmainak commented 3 years ago

@rythorpe any issues that are close to your heart and/or you'd want to tackle? we're thinking of an august release

ntolley commented 3 years ago

Something that's been on my mind for awhile, do you guys thinks it'd be possible to add a sentence or two to the main hnn-core page? At the moment it is extremely cryptic and requires you to go the HNN-GUI repo to figure out that this is a simulator for a neocortical column.

Perhaps

This is a leaner and cleaner version of the code based off the HNN repository, a user friendly tool for the biophysical simulation of a neocortical column. However, a Graphical User Interface is not supported at the moment in this repository.

I can open a PR if you guys agree. Perhaps later it'd also be great to have a picture of the model there as well to make it immediately clear what this repo is for.

jasmainak commented 3 years ago

yes, that's fine! PR is welcome :)

jasmainak commented 3 years ago

okay, I checked some boxes and reordered the issues so it's clearer to what's done and what's left. Expanded the connectivity checklist so it's clear to see what needs to be done there. This issue has also been pinned so it's on top of the priority list.