Publish your Modelling Tool on omilab.org

This section shows how you can add your modelling tool to the collection of tools of the OMiLAB Community: https://www.omilab.org/activities/projects/.

There are two variants for publishing your tool:

• Publish a new version of your modelling tool
• Publish a new modelling tool

Publish a New Version of your Modelling Tool

This section describes how you can publish a new version of an existing modelling tool on OMiLAB's community tools page. The focus here is to create and add the download links for the new tool version.

Prerequisites:

• You have updated and packaged your modelling tool according to the procedure described here
• The installation files in the TOOL folder are up-to-date and tested
• Make sure the ADOxx library (.abl) file in the LIBRARY folder of your GitLab project is the current version of your tool
• The files in the DOCUMENTATION folder of your GitLab project are updated accordingly

To make the new installation files available for download on your project page, you have to make a new release of your tool, in the GitLab project:

1. Open the GitLab project of your tool
   1. Click Deploy
   2. Click Releases
   3. Click New release

Create a new release for your modelling tool

2. Provide a Tag name, containing your version
   1. Open the drop-down menu of the Tag name field
      1a. In the search field type in the new name that you want to use
      1b. Click on Create tag \<your-tag-name\>
      1c. Click on Save
   2. Fill in the Release title
      2a. Fill in the Release date
      2b. Add a description of the release in Release notes
      2c. Add all the information fitting for your tool
   3. Click Create release

Fill out the information for the release

3. Check if the download is available on the modelling tool page
   • Open the webpage of your modelling tool
   1. Click on the Download menu
   2. Check if your new release is shown
   3. Test the download packages

Example of a modelling tool download page

Publish your New Tool on the OMiLAB Community Tools Page

This section describes how you can publish your modelling tool, including download links on OMiLAB's community tools page.

Prerequisites:

• You have already packaged your modelling tool, as described here, including the installation files and the ADOxx library file (.abl) for your modelling tool.
• You have a name and logo for your modelling tool.

You should have a GitLab project containing the following folders (if not check again these steps):

• DOCUMENTATION (containing multiple folders with `` files)
• LIBRARY (containing your .abl file)
• SRC
• TOOL (containing the installation files for your modelling tool)

Your modelling tool should already be visible on OMiLAB's community tool page.

The logo which is shown on the webpage, is the same which is provided as Project avatar for the GitLab project. To change it, follow these steps:

• Open your GitLab project
  1. Click Settings
  2. Click General
  3. Click Choose file (under Project avatar). Search for your logo and confirm it
  4. Click Save changes

Upload the logo to your modelling tool project

The general approach of creating the webpage of the project on OMiLAB's community tools page, is that the provided files are parsed and the webpages are created out of them. Therefore, the content of the webpages is taken from the files and the meta information is provided in the headers of the files. For those familiar, this follows the Jekyll approach. The content of the webpages is formatted using Markdown. Therefore, the meta information is provided at the beginning of the file in between two lines of ---.

To provide all the necessary information, adapt the README file and all the `` files contained in the subfolders of DOCUMENTATION.
Open your local project in Visual Studio Code and when you are finished, push everything to the remote GitLab project (similar as in step 2 from the package procedure documentation).
Fill in the provided attributes in the meta information section and then provide the information in the body, an example for the README file can be seen in the figure below.

Example README file structure

Fill in the information in your README and also all the `` files in DOCUMENTATION sub folders. If you push the files to your GitLab project and reload the webpage of your project, the changes should be shown. If not, try it again after waiting some time or try to refresh with ctrl+shift+r.

After you have provided all the information, you have to create the download links of your modelling tool. Therefore, check if the TOOL and LIBRARY folder of your remote GitLab project are up-to-date and contain the version that should be published.

To make the installation files available for download on the project page, you have to make a new release of your tool, in the GitLab project:

• Open the GitLab project of your tool
  1. Click Deploy
  2. Click Releases
  3. Click New release

Create a new release for your modelling tool

• Provide a Tag name, containing your version
  1. Open the drop-down menu of the Tag name field
     1a. In the search field type in the new name that you want to use
     1b. Click on Create tag \<your-tag-name\>
     1c. Click on Save
  2. Fill in the Release title
     2a. Fill in the Release date
     2b. Add a description of the release in Release notes
     2c. Add all the information fitting for your tool
  3. Click Create release

Fill out the information for the release

• Check if the download is available on the modelling tool page
  • Open the webpage of your modelling tool
  1. Click on the Download menu
  2. Check if your new release is shown
  3. Test the download packages

Example of a modelling tool download page