Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 8.06 KB

README.md

File metadata and controls

71 lines (54 loc) · 8.06 KB
Raw

ODTP: Open Digital Twin Platform

ODTP offers a comprehensive suite of functionalities to enhance digital twins' management, operation, and analysis. In ODTP, a digital twin is an advanced virtual model, embodying a broad spectrum of scenarios and systems that mirror current conditions and forecast future scenarios, offering users a robust platform for strategic optimization and decision-making. With ODTP, the digital twin concept transcends traditional boundaries, providing a pivotal tool for various applications, ensuring adaptability, insight, and innovation across diverse domains.

Features

  • Intuitive User Interface to manage and operate your digital twins.
  • Component Execution to execute your or existing components for simulation, analysis or visualization.
  • Iteration Monitoring to check digital twins iterations.
  • Log Analysis to conveniently access and analyze container logs.
  • Workflow Design Tool to design and run digital twins.
  • Schema Management & Testing to restart and test different schemas for MongoDB / S3.
  • Result Analysis to inspect outputs/snapshots and download results.

How to use it?

Please go to the documentation for instructions: ODTP Documenation

Terminology

  • ODTP: A tool designed to manage, run, and design digital twins. It offers an interface (CLI, and GUI) for running and managing digital twins. It wraps different open source technologies to provide a high level API for the final user.
  • Components (ODTP Term): Extensions generated by us or the community that perform specific tasks in the digital twin. The input/output is validated semantically, and they run within a docker container as an independent micro-service. They can be one of the following categories:
    • Dataloader component.
    • Analytical component.
    • Visualization component.
  • Core/core-optional modules (ODTP Term): These modules are the different parts that we are developing for the ODTP. These core modules include the different classes/methods needed to run the tool and wrap the services used. Some of these modules are not mandatory in order to run ODTP with the minimal features (i.e. running manually odtp components).
  • Services: One service or micro-service, in a micro-services architecture refers to one logical unit that performs one specific task in an independent manner. In ODTP we use different servers to support core modules, such as MongoDB for the database, Minion for the storage, or GraphDB for the knowledge graph storing. But also, from a technical standpoint every component is turned into a micro-service when running. I think this is the part that’s bringing more confusion.

How to Contribute to the ODTP Project

We sincerely appreciate your interest in contributing to the ODTP project. Here is a step-by-step guide to help you through the process:

  • Step 1: Sign the Contributor License Agreement (CLA). Before contributing, please sign a CLA, which clarifies the intellectual property licenses granted with contributions.

  • Step 2: Decide How to Contribute. For minor improvements or fixes, consider opening a new issue or commenting on an existing relevant issue. For significant contributions or discussions before contributing, contact our coordinators at [email protected].

  • Step 3: Follow Our Code of Conduct and Contribution Guidelines. Contributors are expected to adhere to our Code of Conduct, which promotes a respectful and collaborative environment:

    • Inclusivity & Empathy: Everyone is welcome. We value empathy, kindness, and patience.
    • Collaborative Spirit: Resolve conflicts together, assume good intentions, and respect each other’s work.
    • Openness: Encourage public communication for project-related discussions, reserving private channels for sensitive matters.
    • Responsibility & Respect: Be thoughtful in communication. Harassment, insults, or exclusionary behavior are not tolerated.
    • Diversity & Participation: We welcome diverse backgrounds and strive to make everyone feel valued.
    • Language: English is used for project development. Help maintain this standard.

Acknowledgments, Copyright, and Licensing

Acknowledgments and Funding

This work is part of the broader project Open Digital Twin Platform of the Swiss Mobility System (ODTP-SMS) funded by Swissuniversities CHORD grant Track B - Establish Projects. ODTP-SMS project is a joint endeavour by the Center for Sustainable Future Mobility - CSFM (ETH Zürich) and the Swiss Data Science Center - SDSC (EPFL and ETH Zürich). The Swiss Data Science Center (SDSC) develops domain-agnostic standards and containerized components to manage digital twins. This includes the creation of the Core Platform (both back-end and front-end), Service Component Integration Templates, Component Ontology, and the Component Zoo template. The Center for Sustainable Future Mobility (CSFM) develops mobility services and utilizes the components produced by SDSC to deploy a mobility digital twin platform. CSFM focuses on integrating mobility services and collecting available components in the mobility zoo, thereby applying the digital twin concept in the realm of mobility.

Copyright

Copyright © 2023-2024 Swiss Data Science Center (SDSC), www.datascience.ch. All rights reserved. The SDSC is jointly established and legally represented by the École Polytechnique Fédérale de Lausanne (EPFL) and the Eidgenössische Technische Hochschule Zürich (ETH Zürich). This copyright encompasses all materials, software, documentation, and other content created and developed by the SDSC.

Intellectual Property (IP) Rights

The Open Digital Twin Platform (ODTP) is the result of a collaborative effort between ETH Zurich (ETHZ) and the École Polytechnique Fédérale de Lausanne (EPFL). Both institutions hold equal intellectual property rights for the ODTP project, reflecting the equitable and shared contributions of EPFL and ETH Zürich in the development and advancement of this initiative.

Licensing

The core component of the ODTP software is distributed as open-source under the AGPLv3 license. This ensures that all modifications and derivatives remain open source, fostering a collaborative and shared development environment. Detailed terms of the AGPLv3 license can be found in the LICENSE file within this distribution package.

Distinct Licensing for Other Components

Service Component Integration Templates are licensed under the BSD-3 license, allowing for broad compatibility and standardization. Ontology: The foundational ODTP ontology is licensed under the Creative Commons Attribution-ShareAlike (CC BY-SA), promoting open use and ensuring that any derivatives also remain open. Component Zoo Template: The template for the Component Zoo operates under the BSD-3 license, emphasizing broad compatibility and open development. It's important to note that individual components within the Zoo retain their original licenses.

Alternative Commercial Licensing

Alternative commercial licensing options for the core platform and other components are available and can be negotiated through the EPFL Technology Transfer Office (https://tto.epfl.ch) or ETH Zürich Technology Transfer Office (https://ethz.ch/en/industry/transfer.html).

Ethical Use and Legal Compliance Disclaimer

Please note that this software should not be used to harm any individual or entity. Users and developers must adhere to ethical guidelines and use the software responsibly and legally. This disclaimer serves to remind all parties involved in the use or development of this software to engage in practices that are ethical, lawful, and in accordance with the intended purpose of the software.