Derived units now use a DLUnit class similar to a DLPak to be easily stored and loaded, the public API has been updated to either take a DLUnit object or a Path where it reads the DLUnit from a *.dlunit file The .dlunit file is a ZIP compressed archive containing two files, a manifest.json which stores the units uuid, its input signals and its output signal, and unit.py which is the python code for the unit, the same rules apply (one python function with a specifically structured signature) as when a string was passed in the old API Errors have been added to have a DLUnitError similar to the DLPakError as the DLUnit class is heavily inspired from the DLPak architecutre Logging may still be primitive, this will be covered in the next AI logging sweep to homogenize and clean up the logging aspect of things
DynaLab Core Documentation
Warning
Documentation is currently being written. It may contain incomplete or incorrect information. While DynaLab Core is in it's alpha stage it is the users responsibility to cross check the information provided in documentation with the codebase.
This documentation is ordered in the following sections
- API
- Protocol
- Internal
API - Documents the user side API of the Core class, this goes through setting up a new core, and how to interact with it
Protocol - Documents the data ingress protocol, this is useful for developing connectors to pipe data into the DynaLab Core
Internal - Documents the inner working of DynaLab Core including data flow, internal API's, custom file types and much more