Welcome to Stimpyp documentation!

Stimpyp is designed for NERF Stimpy software output parsing, and other utilities.

Compatible Version

stimpy

• pyvstim: Bitbucket master branch

• stimpy: Bitbucket master branch

• stimpy: Github master branch

camera DAQ

• labcams: Archived tagged version, due to Source version still updating

• pycams temp_release branch

Installation

• Required python >= 3.10

pip install stimpyp

Getting Started

Examples

• Getting Started
  • Riglog
    • init riglog
    • as array
    • log config
    • event time and value
  • Stimlog
    • init stimlog
    • common attributes
      • config information
      • visual stim dataframe
      • statemachine dataframe
      • stimulus_segment
      • stimulus on-off pulse
      • profile_dataframe
    • version-specific attributes
      • Github version only
    • Stimulus pattern
  • Camlog
    • labcams versus pycams
    • as dataframe
  • Protocol
    • init protocol
    • protocol options
    • as dataframe
  • Preference
    • init preference
  • Utilities
  • Pyvstim

API Reference

Modules

• stimpyp.base
• stimpyp.stimpy_core
• stimpyp.stimpy_git
• stimpyp.stimpy_pygame
• stimpyp.stimulus
• stimpyp.camlog
• stimpyp.preference