Docker image for running SysML v2

Create a docker image for running SysML v2 Release in Jupyter.

The setup is taken from the Jupyter installation.

In addition, an API Server is also started and everything published in Jupyter will be pushed into this server.

Remote Services

You can try this out on Binder, via DockerHub or just view the notebooks at nbviewer.

Binder

You can run this on Binder but it will only run the SysMLv2-based Jupyter server, not the API server.

Latest version:

Specific versions of the SysMLv2 Releases are also available:

• 2021-02
• 2021-01
• 2020-12
• 2020-11
• 2020-10

You can also view notebooks via nbviewer and from there it's possible to start up Binder.

Dockerhub

Docker images are also available. These are only of the Jupyter installation not the API server.

nbviewer

Links to nbviewer:

• latest
• 2021-02
• 2021-01
• 2020-12
• 2020-11
• 2020-10

Local Usage

Be aware, building the docker images will take a while since all the software packages will be retrieved. Everything is built and run locally.

Prerequistes

• Docker

Everything else is installed by the build process.

Makefile

To start up the SysML-Jupyter server, the postgres server and the API server:

make spin-up

Then point your browser first to http://localhost:9000/docs/ - this will setup the database for the API server. Once this displays a page, then point your browswer to the Jupyter page. This is on http://localhost:8888, don't use the hostname sysmljupyter, that's internal to docker.

    To access the notebook, open this file in a browser:
        file:///root/.local/share/jupyter/runtime/nbserver-1-open.html
    Or copy and paste one of these URLs:
        http://sysmljupyter:8888/?token=392e5b7c0e8cde28d6f988862bc7ad81ba6c517e31b63520
     or http://127.0.0.1:8888/?token=392e5b7c0e8cde28d6f988862bc7ad81ba6c517e31b63520

The token is unique for each start of the container.

NOTE: If localhost does not work in the URLs, try 127.0.0.1 instead.

Using Docker

If you want to do this using docker only, i.e. no makefile, then have a look at the Makefile. Basically it's something along the lines of:

docker build -t sysml.jupyter -f Dockerfile.jupyter .
docker build -t sysml.api     -f Dockerfile.api     .
docker network create thenetwork
docker volume create postgresdbserver
docker-compose -f docker-compose.yml up

That is the same as doing make spin-up.

Production Use?

Don't.

This isn't designed for production use, this is for local or trusted use only.

Example Notebooks

There are a few example notebooks included in the image, their usefulness might vary according to your experience level.

Inspiration

• MBSE4U.com is where I found the meta commands.
• Also from MBSE4U.com, the example notebook at nbviewer.jupyter.org.

Licensing

Both SysMLv2 API Server and SysMLv2 Release are licensed under the LGPL and this continues to be the case.

This project does not make any changes to the existing licensing of the referenced projects.

This project is also licensed under the LGPL.