Skip to main content

Tools to fetch and update paths, metadata and state for Mindscope Neuropixels sessions, in the cloud.

Project description

npc_lims

neuropixels cloud lab information management system Tools to fetch and update paths, metadata and state for Mindscope Neuropixels sessions, in the cloud.

PyPI Python version

Coverage CI/CD GitHub issues

quickstart

  • make a new Python >=3.9 virtual environment with conda or venv (lighter option, since this package does not require pandas, numpy etc.):

    python -m venv .venv
    
  • activate the virtual environment:

    • Windows
    .venv\scripts\activate
    
    • Unix
    source .venv/bin/activate.sh
    
  • install the package:

    python -m pip install npc_lims
    
  • setup credentials

    • required environment variables:
      • AWS S3
        • AWS_DEFAULT_REGION
        • AWS_ACCESS_KEY_ID
        • AWS_SECRET_ACCESS_KEY
        • to find and read files on S3
        • must have read access on relevant aind buckets
        • can be in a standard ~/.aws location, as used by AWS CLI or boto3
      • CodeOcean API
        • CODE_OCEAN_API_TOKEN
        • CODE_OCEAN_DOMAIN
        • to find processed data in "data assets" via the Codeocean API
        • generated in CodeOcean:
          • right click on Account (bottom left, person icon)
          • click User Secrets - these are secrets than can be made available as environment variables in CodeOcean capsules
          • go to Access Tokens and click Generate new token - this is for programatically querying CodeOcean's databases
            • in Token Name enter Codeocean API (read) and check read on capsules and datasets
            • a token will be generated: click copy (storing it in a password manager, if you use one)
          • head back to User Secrets where we'll paste it into a new secret via Add secret > API credentials - in description enter Codeocean API (read) - in API key enter CODE_OCEAN_API_KEY - in API secret paste the copied secret from before (should start with cop_...) CODE_OCEAN_DOMAIN is the codeocean https address, up to and including .org
    • environment variables can also be specified in a file named .env in the current working directory
  • now in Python we can find sessions that are available to work with:

        >>> import npc_lims;
    
    # get a sequence of `SessionInfo` dataclass instances, one per session:
        >>> tracked_sessions: tuple[npc_lims.SessionInfo, ...] = npc_lims.get_session_info()
    
    # each `SessionInfo` instance has minimal metadata about its session:
        >>> tracked_sessions[0]                 # doctest: +SKIP
        npc_lims.SessionInfo(id='626791_2022-08-15', subject=626791, date='2022-08-15', idx=0, project='DRPilotSession', is_ephys=True, is_sync=True, allen_path=PosixUPath('//allen/programs/mindscope/workgroups/dynamicrouting/PilotEphys/Task 2 pilot/DRpilot_626791_20220815'))
            >>> tracked_sessions[0].is_ephys        # doctest: +SKIP
        False
    
    # currently, we're only tracking behavior and ephys sessions that use variants of https://github.com/samgale/DynamicRoutingTask/blob/main/TaskControl.py:
        >>> all(s.date.year >= 2022 for s in tracked_sessions)
        True
    
  • "tracked sessions" are discovered via 3 routes:

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

npc_lims-0.1.185.tar.gz (40.2 kB view details)

Uploaded Source

Built Distribution

npc_lims-0.1.185-py3-none-any.whl (46.5 kB view details)

Uploaded Python 3

File details

Details for the file npc_lims-0.1.185.tar.gz.

File metadata

  • Download URL: npc_lims-0.1.185.tar.gz
  • Upload date:
  • Size: 40.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.4.dev1+g0b7e5fa CPython/3.9.20 Linux/6.5.0-1025-azure

File hashes

Hashes for npc_lims-0.1.185.tar.gz
Algorithm Hash digest
SHA256 6a0284e00e12d2e738a48fb3c682f20279423f95719645f1907d859f6ca96c30
MD5 1b0c815065af835a09d57afd08b72c86
BLAKE2b-256 cf552dfc3955b6e1098fba362d866cf7f10de8b89cfb88e37594b8cceef8c030

See more details on using hashes here.

File details

Details for the file npc_lims-0.1.185-py3-none-any.whl.

File metadata

  • Download URL: npc_lims-0.1.185-py3-none-any.whl
  • Upload date:
  • Size: 46.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.4.dev1+g0b7e5fa CPython/3.9.20 Linux/6.5.0-1025-azure

File hashes

Hashes for npc_lims-0.1.185-py3-none-any.whl
Algorithm Hash digest
SHA256 0f6d25ca762654829c4c031d443ff461295e0f546708cfc9994390847705ab1a
MD5 b7c8508449a2c257c87e9bc2df373cbe
BLAKE2b-256 e31b7352f369d6ab738eeb00a4c5176c731fe76aa1bfc1227fc8cefdd4669fab

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