Skip to main content

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

Metadata

Release files for np-session 0.6.48

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for np-session 0.6.48
File Size Uploaded Provenance
np-session-0.6.48.tar.gz 43.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for np-session 0.6.48
File Interpreter ABI Platform
np_session-0.6.48-py3-none-any.whl Python 3 none any Details

Total release size: 96.8 kB

Release files / np-session-0.6.48.tar.gz

Download URL np-session-0.6.48.tar.gz
Size 43.2 kB
Tags Source
SHA-256 checksum
How to use checksums
631aebf71aad0da680d1bc6b7f4c2d411dc6f83be4dfc86f3e117eed7f3804f5
BLAKE2b-256 checksum
How to use checksums
86d6bb3e3c2f638133e42c7b67d7e75f5c6ad386c1307d7dc2372783380f6c97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.10.4 CPython/3.7.9

Release files / np_session-0.6.48-py3-none-any.whl

Download URL np_session-0.6.48-py3-none-any.whl
Size 53.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aa7169aaa6a8c8a8dbfae7ed9f3d77888e438330068e595e5a7d0d62f3c5924f
BLAKE2b-256 checksum
How to use checksums
b7175041b8b58e453e3e3deac24ccac3d511eac67097c7da4b55688d79b1d7af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.10.4 CPython/3.7.9

Security for np-session 0.6.48

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.6.48 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page