Skip to main content

NWB conversion scripts, functions, and classes for the nwb conversion of Murthy lab

Project description

murthy-lab-to-nwb

NWB conversion scripts for Murthy lab 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 install. 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/murthy-lab-to-nwb
cd murthy-lab-to-nwb
conda env create --file make_env.yml
conda activate murthy-lab-to-nwb-env

This create 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 intereference 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/murthy-lab-to-nwb
cd murthy-lab-to-nwb
pip install -e .

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

Pip installation

You can also install the latest release of the package with pip:

pip install murthy-lab-to-nwb

Repository structure

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

murthy-lab-to-nwb/
├── LICENSE
├── make_env.yml
├── pyproject.toml
├── README.md
├── requirements.txt
├── setup.py
└── src
    ├── __init__.py
    └── murthy_lab_to_nwb
        ├── __init__.py
        ├── cowley2022mapping
        │   ├── cowley2022mapping_courtship_convert_session.py
        │   ├── cowley2022mapping_imaging_convert_session.py
        │   ├── cowley2022mapping_nwbconverter.py
        │   ├── cowley2022mapping_requirements.txt
        │   ├── __init__.py
        │   ├── interfaces
        │   ├── metadata
        │   ├── utils
        │   ├── widget_demostration_courtship.ipynb
        │   └── widget_demostration_imaging.ipynb
        └── li2022ecephys
            ├── __init__.py
            ├── li2022ecephys_convert_session.py
            ├── li2022ecephysinterface.py
            ├── li2022ecephysnwbconverter.py
            └── li2022ecephys.yaml_.py
            └── __init__.py

For example, for the conversion cowley2022mapping you can find a directory located in src/murthy-lab-to-nwb/cowley2022mapping. Inside each conversion directory you can find the following files:

  • cowley2022mapping_courtship_convert_session.py: this runs a nwb conversion for a courtship session.
  • cowley2022mapping_imaging_convert_session.py: this runs a nwb conversion for an imaging session.
  • cowley2022mapping_requirements.txt: dependencies specific to this conversion specifically.
  • widget_demostration_courtship.ipynb jupyter notebook with visulization tools for the courtship nwb file
  • widget_demostration_imaging.ipynb jupyter notebook with visulization tools for the imaging nwb file

Plus the following directories:

  • interfaces directory which holds the interfaces required in this conversion.
  • metadata directory which holds the editable yaml metadata files to add extra metadata to the conversions.
  • utils miscellaneous utilities for the conversion.

Running a specific conversion

To run a specific conversion for a full session you can see here the following examples

python src/murthy_lab_to_nwb/cowley2022mapping/cowley2022mapping_courtship_convert_session.py
python src/murthy_lab_to_nwb/cowley2022mapping/cowley2022mapping_imaging_convert_session.py
python src/murthy_lab_to_nwb/li2022ecephys/li2022ecephys_convert_session.py

You might need to install first some conversion specific dependencies that are located in each conversion directory:

pip install -r src/murthy_lab_to_nwb/cowley2022mapping/cowley2022mapping_requirements.txt

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

murthy-lab-to-nwb-0.0.2.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

murthy_lab_to_nwb-0.0.2-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file murthy-lab-to-nwb-0.0.2.tar.gz.

File metadata

  • Download URL: murthy-lab-to-nwb-0.0.2.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for murthy-lab-to-nwb-0.0.2.tar.gz
Algorithm Hash digest
SHA256 adbda49fb6b27d9fc0cf9ac0c75616e9783fa3567768a1411059e8b9b467b4e0
MD5 02b66988268efe7054f20f399857182e
BLAKE2b-256 a7066a6e1084f155aa96fddb7f12c232179f2a2ad74a67291e881a81c956f289

See more details on using hashes here.

File details

Details for the file murthy_lab_to_nwb-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for murthy_lab_to_nwb-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 de1db1165e4e5cefa272ac0017dcdacfb5b980db0eec2445787c1a04972d66d2
MD5 4640a899f3b2b11ebfef56d30e5d5203
BLAKE2b-256 2f62fefad6cf5f814e5dfa3f4adcdcc1d54f399da04f138d1a1250c9c95e1aa3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page