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

Add miv_data package #76

Merged
merged 13 commits into from
Feb 26, 2024
Merged

Add miv_data package #76

merged 13 commits into from
Feb 26, 2024

Conversation

frthjf
Copy link
Collaborator

@frthjf frthjf commented Feb 23, 2024

MiV-Data

It turns out that the various HDF5 files for simulation construction, inputs, and results are becoming a useful IR since it is easy to share H5 files. However, installation of the MiV-Simulator to just load/process the data can be a substantial and unnecessary hurdle to sharing results with collaborators. After some discussion, I believe the right thing is to separate some key data I/O capabilities into their own package that should be much easier to install.

There is likely going to be some initial iteration and testing of this idea, so this is meant as a low-overhead (and somewhat hacky) incubator. If you have MiV-Simulator installed, it should become available as if it was it's own package (import miv_data).

Installation

To install miv_data without installing MiV-Simulator use the following:

pip install -e "git+https://github.com/GazzolaLab/MiV-Simulator.git@feature/miv-data#egg=miv_data&subdirectory=src"

Rationale

High-level interface to read and write

  • cells.h5 and connections.h5 format used by the MiV-Simulator
  • simulation inputs and results like spike trains etc.
  • experimental recordings (?)

Non-goals

No data processing or plotting algorithms that go beyond what is necessary to read and write from H5 source files. The aim is to be a thin I/O library, nothing more; anything more sophisticated should go into MiV-OS.

@frthjf frthjf requested review from iraikov and skim0119 February 23, 2024 03:53
@frthjf frthjf self-assigned this Feb 23, 2024
@frthjf frthjf marked this pull request as draft February 23, 2024 03:53
@frthjf frthjf marked this pull request as ready for review February 26, 2024 06:06
@frthjf frthjf merged commit 66253e0 into main Feb 26, 2024
9 checks passed
@frthjf frthjf deleted the feature/miv-data branch February 26, 2024 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant