Sympathy for Data

Welcome to the documentation for Sympathy for Data.

Project page:https://www.sympathyfordata.com Author:System Engineering Software Society (SysESS)

Getting started

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

Getting started

• What is Sympathy for Data?
• Installation instructions
  • Using installer
  • Manual install
• Quick start tutorial
  • Working with nodes and workflows
  • Executing a node and looking at the result
  • Loading and executing a workflow
  • Configuring nodes

Important Concepts

Important Concepts

• Concepts in Sympathy for Data
  • Context Menus
  • Workflows
  • Nodes
  • Data types
  • Connections
  • Text fields
  • Control structures
• Subflows
  • Adding ports
  • Subflow settings
  • Subflow configuration
  • Linked Subflows
  • Locked Subflows
  • Subflows in the Node Library
• Lambda

Graphical user interface

Graphical user interface

• The graphical user interface
  • The node library window
  • Messages window
  • Flow overview
  • Undo stack
• Data viewer
  • Preview Table
  • Searchbar
  • Plot

Command line options

Command line options

• Using Sympathy from the command line
  • Sympathy Start options
  • Start options
  • Using environment variables
  • Using config files

Development

Learn how to write nodes and more.

Development

• Node writing
  • Creating new nodes
  • The node code
  • Library tags
  • Adding input and output ports
  • Adding a configuration GUI
  • Errors and warnings
  • Documenting nodes
• How to create reusable nodes
• Advanced node writing
  • Adjust parameters
  • Controllers
  • Using custom port types
  • Managing node updates
  • Custom GUIs
• Debugging, profiling, and tests
  • Debugging nodes
  • Profiling nodes and workflows
  • Writing tests for your nodes
• Creating Plugins
  • Import node plugins
  • Export node plugins
  • Calculator node plugins
• Libraries
  • Creating new libraries
  • Library meta data
  • Library structure
  • Add extra modules to your library
  • Library tags
  • Example flows
• Creating a custom data type
  • Create typeutils class
  • Locate port type
  • Create port type
  • Create an example node
  • Adding an icon
  • Extend the data viewer
• Using and supporting Python 3
  • Differences between Python 3 and Python 2
  • Python 2 and Python 3 compatibility
  • Python 3 only
• Using library nodes from python
  • Loading the Library
  • Loading nodes
  • Working with configurations
  • Working with nodes

API Reference

API Reference

• Node interface reference
  • Node definition
  • Overridable node methods
  • Callable node methods
  • Node context reference
• Parameter helper reference
  • Adding scalar parameters
  • Adding lists
  • Adding groups and pages
  • Editors
• Data type APIs
  • Built in Types
  • Built in TypeAliases
  • Other data types

Libraries

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

Libraries

• Typical workflow structure
  • Importing data
  • Prepare data
  • Analyze data
  • Export data as plots or reports
  • Working with ADAF
• Machine Learning Concepts
  • Pre-processing data
  • Varying number of parameters
  • Pipelines
  • Machine learning examples
• Library
  • Internal
  • Sympathy
  • Plugins

Changes

Changes

• What’s new
  • 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
  • Input typed values as text