welcome

Welcome to the ATOM SDK development manual!

ATOM SDK is a multi-language client library (Python / C++ / C#) for operating ATOM software, providing graph editing, node operations, runtime execution and other capabilities. The prerequisite for use is that there is already a connectable ATOM software running (local or remote).

ATOM SDK provides 4 Service, which are responsible for different operation domains:

Service Responsibilities Access method (Python)

GraphService

Create, open, import and export, and run the entire image of the main image

client.graph

NodeService

Node addition, deletion, connection, parameter setting, and single node activation in the main graph

client.node

GraphNodeService

Node editing and running inside subgraph nodes

client.graph_node

RuntimeService

Load and run graphs as execution engines, handling multi-frame input

client.runtime

Please select the language used by the project to enter the corresponding chapter.

quick start

basic concepts

User Guide

API Reference

Architecture overview

your program
    │
    ▼
AtomClient(unified entrance)
    ├── GraphService      ← graph level operations
    ├── NodeService       ← Main graph node operations
    ├── GraphNodeService  ← Subgraph node operations
    └── RuntimeService    ← Runtime execution
    │
    ▼
atom Software(HTTP API service)

All Service communicate with ATOM software through HTTP. SDK is responsible for automatically managing timestamp (map version number) to avoid concurrency conflicts, handling binary and JSON mixed responses, and automatic uploading of file parameters.