Overview of the APIs
This section of the documentation provides a comprehensive reference for the core APIs used in DeWorks. These models define the data structure and behaviour of materials, properties, process, records, and project management workflows.
Whether you're building new functionality, developing automated workflows, or analyzing results, this guide will help you understand and use each component effectively.
What You'll Find Here
- Detailed Reference: Each model is documented with its fields, computed properties, methods, and validation logic.
- Usage Examples: Many methods include minimal examples to demonstrate how to call them correctly.
- Model Relationships: Understand how models like
mat_info,mat_record,Record,process,PROPERTY,Project, andcluster_setupintegrate into a complete workflow.
Core Models Overview
| Model | Purpose |
|---|---|
cluster_setup |
Describes remote computing environment and job submission parameters |
mat_record |
A specialised Record tailored for individual material handling and property resolution |
mat_info |
Stores static material data pulled from external sources |
process |
Base class for jobflow-compatible calculation workflows |
PROPERTY |
Abstract base for physical property representations |
Project |
Manages collections of Record instances and system-wide calculations |
Record |
Tracks the full history and results for a material |
Info |
Generalised wrapper for storing immutable structured data |