Install
Prerequisites
RemotiveTopology will run the topology with the help of docker containers that interact with each other. Thus, you need Docker. We also support Podman as an alternative, simply replace docker
with podman
in all instructions.
To develop behavioral models for RemotiveTopology, you need Python 3.9 or later.
Installation
The easiest way to install and run is to use Docker. You also find binaries of RemotiveTopology CLI.
Install or upgrade to latest version:
docker pull remotivelabs/remotive-topology:latest
Then follow these instructions depending on platform:
MacOS
Add the following alias in for example ~/.zshrc
:
alias remotive-topology='docker run -v $(pwd):$(pwd) -w $(pwd) -it remotivelabs/remotive-topology:latest'
Restart your terminal.
Linux
Add the following alias in for example ~/.bashrc
:
alias remotive-topology='docker run -u $(id -u):$(id -g) -v $(pwd):$(pwd) -w $(pwd) -it remotivelabs/remotive-topology:latest'
Restart your terminal.
Download and install the latest version of DockerCAN from https://releases.remotivelabs.com/#docker_can/
Windows
In powershell open your profile:
notepad $PROFILE
Add the following line at the bottom:
function remotive-topology { docker run -v ${PWD}:/data -it remotivelabs/remotive-topology:latest @Args }
Restart powershell.
Editor setup
RemotiveTopology uses yaml files to describe instances and platforms. We strongly recommend that you configure our json schema in your editor to make it easier to edit these files.
Visual Studio Code
Install Red Hat YAML plugin
Add the following to your settings.json
:
"yaml.schemas": {
"https://files.remotivelabs.com/remotive_topology/topology-0.5.schema.json":
["*.instance.yaml", "*.platform.yaml"]
},
Usage
Run the following to get further instructions:
remotive-topology --help
See Getting started for next steps.
Important
It is important that you run all remotive-topology
commands at the root of your project folder. This allows all files to
be accessed correctly inside the docker container. This also includes all output folders!
- Do not use absolute paths
- Do not use
..
On Windows: Since remotive-topology
is running in a docker container using Linux you might encounter some unexpected warnings or errors.
Your files are mounted inside the container using current working directory to the /data
folder. This means that you might see
error messages referring to files /data/something/somefile.instance.yaml
. Remember that this means that your actual file is
located ./something/somefile.instance.yaml
!