Syncopy Developer Guide

The following information is meant for advanced users with an understanding of class hierarchies that want to extend and/or modify Syncopy’s base functionality.

• Syncopy Data Classes
  • Usable Syncopy Data Classes
• Reading and Writing Data
  • The Syncopy Data Format (*.spy)
  • Reading Other File Formats
• Tools for Developing Syncopy
  • Input Parsing and Error Checking
  • Decorators
  • Writing A New Analysis Routine
• Design Guide: Syncopy Compute Classes
  • Designing a computeFunction()
  • The Algorithmic Layout of ComputationalRoutine
  • Examples
  • Additional return values for backend and compute functions
• Controlling Logging in Syncopy
  • Log levels
  • Log file location
  • Logging code that runs locally
  • Logging code that potentially runs remotely
• API for Developers
  • syncopy.datatype
  • syncopy.misc
  • syncopy.shared
  • syncopy.specest
  • syncopy.nwanalysis
  • syncopy.plotting