Skip to main content

Tools for accessing data, metadata, and jobs related to ecephys and behavior sessions for the Mindscope Neuropixels team.

Project description

np_session

For use on internal Allen Institute network

A lightweight package for handling file paths and metadata associated with Mindscope Neuropixels experiments with data on local rig-connected machines or the /allen network. Provides an interface that can be used by other applications.

>>> from np_session import Session

# initialize with a lims session ID or a string containing one: 
>>> session = Session('c:/1116941914_surface-image1-left.png') 
>>> session.lims.id
1116941914
>>> session.folder
'1116941914_576323_20210721'
>>> session.is_ecephys
True
>>> session.rig.acq # hostnames reflect the computers used during the session, not necessarily the current machines
'W10DT05515'

# some properties are objects with richer information:
>>> session.mouse
Mouse(576323)
>>> session.project
Project('NeuropixelVisualBehavior')

# - `pathlib` objects for filesystem paths:
>>> session.lims_path.as_posix()
'//allen/programs/braintv/production/visualbehavior/prod0/specimen_1098595957/ecephys_session_1116941914'
>>> session.data_dict['es_id']
'1116941914'

# - `datetime` objects for easy date manipulation:
>>> session.date
datetime.date(2021, 7, 21)

# - dictionaries from lims (loaded lazily):
>>> session.mouse.lims
LIMS2MouseInfo(576323)
>>> session.mouse.lims.id
1098595957
>>> session.mouse.lims['full_genotype']
'wt/wt'

# with useful string representations:
>>> str(session.mouse)
'576323'
>>> str(session.project)
'NeuropixelVisualBehavior'
>>> str(session.rig)        # from `np_config` package
'NP.0'

Adding a new project

  • Add an enum with any project identifiers (e.g. lims project code) to components.info.Projects

  • Create an entry for lims manifests (if applicable) in Zookeeper at projects/np_session/manifests

    • the D1 manifest will need customizing (see other entries)
    • the default D0 and D2 manifests will likely suffice: nothing needs to be done

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

np-session-0.6.48.tar.gz (43.2 kB view details)

Uploaded Source

Built Distribution

np_session-0.6.48-py3-none-any.whl (53.6 kB view details)

Uploaded Python 3

File details

Details for the file np-session-0.6.48.tar.gz.

File metadata

  • Download URL: np-session-0.6.48.tar.gz
  • Upload date:
  • Size: 43.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.10.4 CPython/3.7.9

File hashes

Hashes for np-session-0.6.48.tar.gz
Algorithm Hash digest
SHA256 631aebf71aad0da680d1bc6b7f4c2d411dc6f83be4dfc86f3e117eed7f3804f5
MD5 8e20d1f3008fb823c5b5e3d947fa7951
BLAKE2b-256 86d6bb3e3c2f638133e42c7b67d7e75f5c6ad386c1307d7dc2372783380f6c97

See more details on using hashes here.

File details

Details for the file np_session-0.6.48-py3-none-any.whl.

File metadata

  • Download URL: np_session-0.6.48-py3-none-any.whl
  • Upload date:
  • Size: 53.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.10.4 CPython/3.7.9

File hashes

Hashes for np_session-0.6.48-py3-none-any.whl
Algorithm Hash digest
SHA256 aa7169aaa6a8c8a8dbfae7ed9f3d77888e438330068e595e5a7d0d62f3c5924f
MD5 0840be16fbe9adac69cf8c589830c498
BLAKE2b-256 b7175041b8b58e453e3e3deac24ccac3d511eac67097c7da4b55688d79b1d7af

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