STEPlib SysML: STEPdev virtual machines

Warning

This page is under construction.

To contribute or participate contact support@boost-lab.net

This page explains how to begin with the STEPdev virtual machines.

Why a virtual machine

We realized during summer 2018 that even if we have developed scripts for the quality check, it was difficult to use them because we are a big team with heterogeneous operating systems and different ways of working.

Then we have imagined a virtual machine which will be:

• always up to date at the version of the softwares used by all of us (Python, Saxon, Ruby, Express Express Engine, Sphinx...),
• using environment variables in order to harmonize and facilitate the way to run the scripts,
• data free, the data used are those of your computer

Why two virtual machines

The light virtual machine is convenient to launch the scripts with aliases or command lines.

• Docker Desktop community edition is required,
• It can be installed from Windows (7 and 10), Linux and Mac OS.

The complete virtual machine loads graphical softwares such as Eclipse or Magic Draw.

• Virtualbox is required

Tip

Request a demo by sending an email to support@boost-lab.net

Note

To go further to the STEPdev virtual machines, have a look on the User Manual http://git2.boost-lab.net/admins/stepdev-vms/blob/master/User_Manual.pdf

Build documentation of 10303-239, 10303-243, 10303-4000 and 10303-4442 with the VMs

The complete documentation is available here Standard Documents Generation.

Build 10303-239 and 10303-243

Task	Action
Checkout the repository	See with the team which branch of the Harmonization-fork-STEP-updated-architecture
Export the diagrams	In MagicDraw, open the mdzip project check the image output settings (see Export images from MagicDraw in the Standard Documents Generation.) select the packages and run the exportDiagrams macro (see Export images from MagicDraw in the Standard Documents Generation.)
Check the variables of the STEPDev virtual machine only for the docker version of the VM	go to docker_container folder, open config.txt file and check: mount harmo should be your local Harmonization-STEP-updated-architecture up-to-date repository. Please pay attention to the branch. mount work should be your current folder. We recommend to use an empty folder. mount tmp should be your tmp folder. make sure that $SLSCRIPTS is /harmo/STEPlib/utils $AP is /harmo/STEPlib/Application_protocols/AP239 or AP243 $WORK is /work and ensure that the alias Build_10303-AP exists
Launch the VM	go to the docker_container folder and enter ./launch_vm.sh when the VM is started, enter cd $WORK
Run the script	Warning: the following folders have to be empty $WORK/output/data $WORK/output/html $WORK/AntPub/output/data/core_model $SLSCRIPTS/AntPub/input/maps $WORK/output/sysml_models_ids.xml $SLSCRIPTS/AntPub/input/sysml_models_ids.xml The core_model data should be added in /Antpub/outpub/data This can be done after the generation of the publication. when you are ready, enter Build_10303-AP 239 plcs or Build_10303-AP 243 mossec You will find the build in your /Antpub/outpub/data/application_protocols. Use home.htm to display the publication.

Build 10303-4000

Task	Action
Checkout the repository	the CTC-harmonization_rebased branch of the Harmonization-fork-STEP-updated-architecture
Export the diagrams	In MagicDraw, open the Core_model.mdzip project check the image output settings (see Export images from MagicDraw in the Standard Documents Generation.) select the Core_model package and run the exportDiagrams macro (see Export images from MagicDraw in the Standard Documents Generation.)
Check the variables of the STEPDev virtual machine only for the docker version of the VM	go to docker_container folder, open config.txt file and check: mount harmo should be your local Harmonization-STEP-updated-architecture up-to-date repository mount work should be your current folder. We recommend to use an empty folder. make sure that $SLSCRIPTS is /harmo/STEPlib/utils $CORE is /harmo/STEPlib/Core_model $WORK is /work and ensure that the alias Build_10303-4000 exists
Launch the VM	go to the docker_container folder and enter ./launch_vm.sh when the VM is started, enter cd $WORK
Run the script	Warning: the following folders have to be empty $WORK/output/data $WORK/output/html $WORK/AntPub/output/data/core_model $SLSCRIPTS/AntPub/input/maps when you are ready, enter Build_10303-4000 You will find the build in your /Antpub/outpub/data/core_model

Build 10303-4442

Task	Action
Checkout the repository	the AP242_ed2_IS_Amendment branch of the Harmonization-fork-STEP-updated-architecture
Export the diagrams and make the xml	In MagicDraw, open the Domain_model.mdzip project check the image output (Tab File/Save as image) settings : png, 150 dpi and 120% in the Tools tab, select the Report Wizard, then the Web Publisher 2.0 (in the default template section) and generate the report. in the File tab, select the Export to, then the Eclipse UML 2 XMI file. in the File tab, select the Save as image, modify the settings to 150%, select all the diagrams and export the images into $WORK/picturesToPrint folder. You can also use the macro “exportDiagramsMacro”.
Check the variables of the STEPDev virtual machine only for the docker version of the VM	go to docker_container folder, open config.txt file and check: mount harmo should be your local Harmonization-STEP-updated-architecture up-to-date repository mount work should be your current folder. We recommend to use an empty folder. make sure that $SLSCRIPTS is /harmo/STEPlib/utils $STEPMODTRIAL is your STEPmod repository for the build $WORK is /work and ensure that the alias Build_10303-4442 exists
Launch the VM	go to the docker_container folder and enter ./launch_vm.sh when the VM is started, enter cd $WORK
Run the script	Warning: the following folders have to be empty $WORK/AntPub/input/maps $WORK/output $WORK/AntImp when you are ready, to run the script you have many options. the full build, with all the pictures, this can take a while: $SLSCRIPTS/STEPDevScripts/build_10303-4442.sh $WORK/magicDraw_files -night -full the full build, with all the pictures, but XSD and EXPRESS generation and AntPub are manually added to the output files: $SLSCRIPTS/STEPDevScripts/build_10303-4442.sh $WORK/magicDraw_files -day -full the same, without the management of the pictures all the doc: $SLSCRIPTS/STEPDevScripts/build_10303-4442.sh $WORK/magicDraw_files -night the doc, but XSD and EXPRESS generation and AntPub are manually added to the output files: $SLSCRIPTS/STEPDevScripts/build_10303-4442.sh $WORK/magicDraw_files -day the next step is to build, from STEPmod, the 4442 in a change request or an application protocol.

Section author: Veronique Dubillot [Boost Conseil]