Sympathy for Data

Welcome to the documentation for Sympathy for Data.

Project page

https://www.sympathyfordata.com

Author

Combine Control Systems AB

Getting started

Want to learn more about what Sympathy for Data is and what it can do for you?

Getting started

• About
• Installation
  • Self-contained installer
  • Manual install
• Quick start
  • Working with nodes and workflows
  • Executing a node and looking at the result
  • Loading and executing a workflow
  • Context Menus
  • Configuring nodes
• Typical workflow
  • Importing data
  • Prepare data
  • Analyze data
  • Export data as plots or reports
  • Working with ADAF
  • Control structures

Workflow elements

Workflow elements

• Workflows
• Nodes
  • Node states
  • Missing Nodes
  • Ports
• Data types
  • Datasource
  • Table
  • ADAF
  • Text
  • Figure
  • Lists
  • Tuples
  • Generic types
  • Function types (Lambda function)
• Connections
  • Creating connections
  • Deleting connections
  • Route points
• Text fields
• Subflows
  • Adding ports
  • Subflow settings
  • Subflow configuration
  • Linked Subflows
  • Locked Subflows
  • Subflows in the Node Library
  • Missing subflows
  • Optional ports
• Lambda
• Migrations
  • Migrations and overrides

Graphical user interface

Graphical user interface

• Windows
  • Library window
  • Messages window
  • Flow overview
  • Undo stack
• Data viewer
  • Preview Table
  • Searchbar
  • Plot
• Node configuration
  • Message area
  • View
  • Buttons
• Preferences
  • General
  • Node Libraries
  • Python
  • Environment
  • Debug
  • Advanced
  • Credentials
• Reporting issues
  • Issues with nodes
  • Issues with the platform

Command line interface

Command line interface

• Command line
  • Top-level commands
  • Command options
  • Noteable examples
  • Shortcuts
  • Using environment variables
• Nodes in python
  • Loading the Library
  • Loading nodes
  • Working with configurations
  • Working with nodes

Development

Learn how to write nodes and more.

Development

• Nodes
  • Introduction
  • Creating new nodes
  • The node code
  • Library tags
  • Adding input and output ports
  • Adding a configuration GUI
  • Errors and warnings
  • Documenting nodes
  • Reusable nodes
  • Adjust parameters
  • Controllers
  • Using custom port types
  • List nodes
  • Managing node updates
  • Custom GUIs
  • Debugging nodes
  • Profiling nodes and workflows
  • Writing tests for your nodes
• Plugins
  • Import node plugins
  • Export node plugins
  • Calculator node plugins
• Libraries
  • Creating new libraries
  • New Library Format
  • Old Library Format
  • Add extra modules to your library
  • Library tags
  • Example flows
• Data types
  • Create typeutils class
  • Locate port type
  • Create port type
  • Create an example node
  • Adding an icon
  • Extend the data viewer

API Reference

API Reference

• Nodes
  • Node definition
  • Node docstring
  • Overridable node methods
  • Callable node methods
  • Node context reference
  • Node helper functions
• Parameters
  • Adding scalar parameters
  • Adding lists
  • Adding groups and pages
  • Editors
• Data types
  • Built in Types
  • Built in TypeAliases
  • Other data types

Libraries

Documentation for each type of node in the standard library of Sympathy for Data. Right-clicking on any node in the GUI and choosing Help will bring you to the help page for that specific node.

Libraries

• Library
  • Nodes
  • Plugins

Changes

Changes

• What’s new
  • News in 4.0.0
  • News in 3.2.0
  • News in 3.1.0
  • News in 3.0.1
  • News in 3.0.0
  • News in 2.2.0
  • News in 2.1.1
  • News in 2.1.0
  • News in 2.0.0
  • News in 1.6.2
  • News in 1.6.1
  • News in 1.6.0
  • News in 1.5.3
  • News in 1.5.2
  • News in 1.5.1
  • News in 1.5.0
  • News in 1.4.5
  • News in 1.4.4
  • News in 1.4.3
  • News in 1.4.2
  • News in 1.4.1
  • News in 1.4.0
  • News in 1.3.5
  • News in 1.3.4
  • News in 1.3.3
  • News in 1.3.2
  • News in 1.3.1
  • News in 1.3 series
  • News in 1.2 series
• Deprecations

Appendix

Appendix

• Appendix
  • Encoding text
  • Input typed values as text
  • All command line options

Privacy Notice

Privacy Notice

• Privacy Notice