Sympathy for Data

Welcome to the documentation for Sympathy for Data.

Project page:

https://www.sympathyfordata.com

Author:

Combine Control Systems AB

Getting started

Getting started

• Quick start
• Typical workflow

Workflow elements

Workflow elements

• Workflows
• Nodes
• Connections
• Text fields
• Subflows
• Lambda
• Migrations
• Libraries

Graphical user interface

Graphical user interface

• Windows
• Data viewer
• Node configuration
• Preferences
• Reporting issues

Node library

Documentation for each node in 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.

Node library

• Library
  • Nodes
  • Plugins
• Port types
  • Datasource
  • Table
  • ADAF
  • Text
  • Figure
  • Report
  • Model (Machine Learning)
  • Lists
  • Tuples
  • Generic types
  • Function types (Lambda function)
  • Graph 365
  • MongoDB
  • PowerBi
  • Dataset

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
  • Reference

Development

Learn how to write nodes and more.

Development

• Nodes
  • Node writing
  • 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
  • Reload libraries
  • Creating new libraries
  • New Library Format
  • Old Library Format
  • Add extra modules to your library
  • Library tags
  • Example flows
  • Documenting Libraries
• 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
  • Base classes
  • Other data types

Changes

Changes

• Releases
• Deprecations

Appendix

Appendix

• Appendix
  • Installation from wheel
  • Encoding text
  • Input typed values as text
  • Json query syntax
  • All command line options
  • Logging
  • Regular expression syntax
  • Graphviz
  • Return codes
  • License Management Documentation