docs
Introduction

Jingongo Framework SDK

PyPI version (opens in a new tab) License: Apache-2.0 (opens in a new tab) Python Versions (opens in a new tab)

Welcome to the Jingongo SDK! This Python library is your gateway to the Jingongo Digital Twin Platform. It provides the essential tools to programmatically convert your simulation models into industry-standard Functional Mock-up Units (FMUs) and manage them in the cloud.

This SDK handles the complex work of packaging your local code, uploading it securely, and communicating with our powerful cloud-based conversion engine. It is the perfect companion to the user-friendly web platform at www.jingongo.com (opens in a new tab).

The Jingongo Vision: A Complete Digital Twin Ecosystem

While the current SDK focuses on robust FMU conversion, Jingongo is being built as a comprehensive platform for the entire digital twin lifecycle. Our goal is to empower engineers and scientists with a seamless workflow from concept to real-time operation.

✨ Current Features (Ready Today)

  • Simple Conversion: Turn local Python or C models into FMUs with a single command.
  • Cloud-Powered Engine: Offload the heavy lifting of compilation and packaging to a scalable cloud service.
  • Model Management: Programmatically list your cloud models and download completed FMUs.
  • Flexible Configuration: Define your model's parameters, inputs, and outputs using a simple .jingongo.yml file.
  • Secure by Design: All communication is authenticated using secure API keys.

🛠️ Future Features (Under Active Development)

  • Integrated Testing: Test your models against various scenarios directly within the Jingongo cloud environment.
  • Advanced Version Control: Manage versions of any model format (FMU, Simulink, etc.) with a clear history and rollback capabilities.
  • Live Data Connection: Easily connect your digital twins to real-time data streams from physical assets for performance monitoring and optimization.
  • Rapid Prototyping: Assemble complex digital twins from a library of pre-built "LEGO block" models to accelerate development.
  • AI-Powered Model Creation: Use our platform to generate powerful simulation models directly from high-level requirements.
Installation Guide