Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/catalystneuro/fee-lab-to-nwb

https://github.com/catalystneuro/fee-lab-to-nwb

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

nwb-conversion

Keywords from Contributors

nwb
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: catalystneuro
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 224 KB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Topics
nwb-conversion
Created about 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog License

README.md

fee-lab-to-nwb

NWB conversion scripts for the Fee Lab at MIT data to the Neurodata Without Borders data format.

Clone and install

To run the conversion some basic machinery is needed: python, git and pip. For most users, we recommend you to install conda (installation instructions) as it contains all the required machinery in a single and simple installation. If your system is windows you might also need to install git (installation instructions) to interact with this repository.

From a terminal (note that conda should install one in your system) you can do the following:

git clone https://github.com/catalystneuro/fee-lab-to-nwb cd fee-lab-to-nwb conda env create --file make_conda_env.yml conda activate fee_lab_to_nwb_env

This creates a conda environment which isolates the conversion from your system. We recommend that you run all your conversion related tasks and analysis from that environment to minimize the interference of this code with your own system.

Alternatively, if you want to avoid conda altogether (for example if you use another virtual environment tool) you can install the repository with the following commands using only pip:

git clone https://github.com/catalystneuro/fee-lab-to-nwb cd fee-lab-to-nwb pip install -e .

Note: both of the methods above install the repository in editable mode

You can also install the latest release of the package with pip: pip install fee-lab-to-nwb

Repository structure

Each conversion is organized in a directory of its own in the src directory:

fee-lab-to-nwb/
├── LICENSE
├── make_env.yml
├── pyproject.toml
├── README.md
├── requirements.txt
├── setup.py
└── src
    ├── fee_lab_to_nwb
    │   ├── general_interfaces
    │   └── scherrer_ophys
    │       ├── convert_session.py
    │       ├── metadata.yml
    │       ├── notes.md
    │       ├── requirements.txt
    │       ├── scherrerophysimagingextractor.py
    │       ├── scherrerophysimaginginterface.py
    │       ├── scherrerophysnwbconverter.py
    │       └── __init__.py

    └── __init__.py

For the conversion scherrer_ophys you can find a directory located in src/fee-lab-to-nwb/scherrer_ophys. Inside the conversion directory you can find the following files:

  • convert_session.py: this is the central script that you must run in order to perform the full conversion.
  • metadata.yml: metadata in yaml format for this specific conversion.
  • notes.md: notes and comments about the source data.
  • requirements.txt: dependencies specific to this conversion.

The other files that are necessary this specific conversion: * scherrerophysimagingextractor.py: the extractor for a single ophys file. * scherrerophysimaginginterface.py: the interface for this ophys dataset. * scherrerophysnwbconverter.py: the place where the NWBConverter class is defined.

The directory might contain other files that are necessary for the conversion but those are the central ones.

Running a specific conversion

To run a specific conversion, you might need to install first some conversion specific dependencies that are located in each conversion directory: pip install -r src/fee_lab_to_nwb/scherrer_ophys/requirements.txt

You can run a specific conversion with the following command: python src/fee_lab_to_nwb/scherrer_ophys/convert_session.py Note that when installing fee-lab-to-nwb from pip the conversion script will be located wherever pip installs site packages. In this case you will need to manually copy/paste usage scripts to a location where you want to use them.

Questions during a conversion

If you encounter any problems during the conversion, open an issue, and we will help you!

Owner

  • Name: CatalystNeuro
  • Login: catalystneuro
  • Kind: organization
  • Email: hello@catalystneuro.com

GitHub Events

Total
Last Year

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 245
  • Total Committers: 4
  • Avg Commits per committer: 61.25
  • Development Distribution Score (DDS): 0.273
Top Committers
Name Email Commits
weiglszonja w****a@g****m 178
pre-commit-ci[bot] 6****]@u****m 35
Cody Baker 5****D@u****m 31
Cody Baker c****9@n****u 1
Committer Domains (Top 20 + Academic)
nd.edu: 1

Issues and Pull Requests

Last synced: over 2 years ago

All Time
  • Total issues: 10
  • Total pull requests: 61
  • Average time to close issues: 12 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 1.4
  • Average comments per pull request: 0.84
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 18
Past Year
  • Issues: 0
  • Pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 11
View more stats
Top Authors
Issue Authors
  • weiglszonja (5)
  • CodyCBakerPhD (5)
Pull Request Authors
  • weiglszonja (40)
  • pre-commit-ci[bot] (21)
  • CodyCBakerPhD (3)
Top Labels
Issue Labels
Pull Request Labels
bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 15 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 2
pypi.org: fee-lab-to-nwb

NWB conversion scripts, functions, and classes for the Fee lab.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 15 Last month
Rankings
Dependent packages count: 6.6%
Average: 28.7%
Forks count: 30.5%
Dependent repos count: 30.6%
Downloads: 36.5%
Stargazers count: 39.1%
Maintainers (2)
szonjaweigl cbaker9
Last synced: 10 months ago

Dependencies

requirements.txt pypi
  • ndx-events ==0.2.0
  • nwbinspector *
  • opencv-python ==4.5.5.64
.github/workflows/deploy-tests.yml actions
pyproject.toml pypi
setup.py pypi
.github/workflows/add-to-dashboard.yml actions
  • leonsteinhaeuser/project-beta-automations v1.2.1 composite
.github/workflows/assess-file-changes.yml actions
  • actions/checkout v3 composite
  • tj-actions/changed-files v29.0.4 composite
.github/workflows/auto-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish v1.4.2 composite
.github/workflows/test-install.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • jannekem/run-python-script-action v1 composite
src/fee_lab_to_nwb/happ_ecephys/requirements.txt pypi
  • ndx-hierarchical-behavioral-data >=0.1.1
  • ndx_sound >=0.2.0
  • neuroconv ==0.2.2
  • openpyxl ==3.0.10
src/fee_lab_to_nwb/scherrer_ophys/requirements.txt pypi
  • natsort >=8.2.0
  • ndx-extract >=0.2.0
  • neuroconv ==0.2.2
  • opencv-python ==4.5.5.64