DeltaTwin command line for managing Delta project
Project description
DeltaTwin® service
GAEL Systems is developing a dedicated service, named "DeltaTwin® Service" to facilitate modelling activities of digital twins.
It aims to offer a collaborative environment for building and running multi-scale and composable workflow, leveraging the numerous available data sources, sharing results, and easing interoperability with other digital twin standards and system dynamics models.
The DeltaTwin® is the central element for the management of workflows, resources and their results. They follow a precise structure folder to ensure they are handled by the DeltaTwin® service.
The service includes the “drive” element in charge of handling DeltaTwin®
storage, their configuration and versionning.
The “run“ element is in charge of the models executions and their monitoring.
The DeltaTwin® command line allows user to control the management of the later modules. It allows user to either work online and perform all actions in a cloud environment or locally using your computer's resources.
DeltaTwin® service also provides a web application to graphically manages your Deltatwins and their execution.
DeltaTwin® Command-line
The command line interface allows the user to configure a DeltaTwin and manage its run operation either from the a shell command prompt or with a script.
The commands are divided into five main groups:
- those that allow user to configure and manage the DeltaTwin’s composition
(
deltatwin drive
) - those dedicated to the to the run concept (
deltatwin run
) - those which help to get information on DeltaTwin® (
deltatwin get
deltatwin list
) - those which give general information on service (
deltatwin version
) - those which allow connexion (
deltatwin login
)
Installation
DeltaTwin® command-line can be installed using pip:
pip install deltatwin-cli
DeltaTwin API
Commands are described below.
These descriptions are also available by using the --help
option on each
individual command.
deltatwin command | parameters | description |
---|---|---|
drive | DeltaTwin drive is dedicated to manage DeltaTwin project repository. | |
run | DeltaTwin run uses models stored into Delta component repository | |
get | Get the information of a DeltaTwin component. | |
version | -all: show all deltatwin components versions. | Show DeltaTwin version and check if deltatwin is properly installed. |
list | List the DeltaTwin from marketplace | |
login | -a api.url -c conf.ini path | logs the user to the service, and allows the use of commands, such as deltatwin list command,that require online registration |
Configured deltatwin information will be stored into $HOME/.delta/config.json
DeltaTwin drive API
The deltatwin drive
is the command line dedicated to handle DeltaTwin project repository.
It stores all the configuration, resources, models and sources to run a DeltaTwin and retrieve data.
For more details, use the parameter --help
.
DeltaTwin run API
DeltaTwin run module uses models stored into DeltaTwin repository. The command is deltatwin run
The objective of this service is to allow edition and run of the models stored into the DeltaTwin.
The run can be done remotely and locally when possible.
Run results shall be stored into the artifact folder of the deltatwin drive environment.
For more details, use the parameter --help
.
DeltaTwin get API
Get information about a DeltaTwin component by specifying its name. By default, the command
returns information for the latest version of the Delta component. To get information
about a previous version, you must specify it with the --version option
deltatwin get [deltatwin_name] --version x.y.z
. To get the list of all available versions you
can either use deltatwin list --version
or deltatwin get [deltatwin_name] --version
.
DT_NAME : DeltaTwin component name [MANDATORY]
DeltaTwin version API
Command deltatwin version
shows DeltaTwin version and check if deltatwin is properly installed.
For more details, use the parameter --help
.
DeltaTwin list API
deltatwin list
Lists the DeltaTwin from marketplace
For more details, use the parameter --help
.
DeltaTwin login API
The command deltatwin login
logs the user to the service. We use it in the form:
deltatwin login <username> <password> [options]
For more details, use the parameter --help
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file deltatwin_cli-1.4.0.tar.gz
.
File metadata
- Download URL: deltatwin_cli-1.4.0.tar.gz
- Upload date:
- Size: 37.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fd3a12e152b900fac41c07586f212f7e02358be27557d4128446c7c266d5097 |
|
MD5 | 12116cad5a83b82118c3ed5b2d14cd42 |
|
BLAKE2b-256 | ad9328a867895c7703466e28f0e618b3968cabc6155df75566ad6581f80b9a8d |
File details
Details for the file deltatwin_cli-1.4.0-py3-none-any.whl
.
File metadata
- Download URL: deltatwin_cli-1.4.0-py3-none-any.whl
- Upload date:
- Size: 38.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 308daf3c75bfc199a60224f3c954c1588aeccc1dc62981232d589ff06649d999 |
|
MD5 | 13ab7eb7f8f3a383cb8c0d4d3e05a85b |
|
BLAKE2b-256 | 4f83f7438e3bf388f7f9f528c49351597a09e93922b6f1ba6b7818c01148643c |