How to Create a Simple Axii Module for a Project

When creating a new project, it is usually a good idea to create a corresponding Axii module in a suitable Axii module database. (For students at H²T, this is here.)

For an in-depth documentation, refer to the documentation of Axii itself.

You can start with this module definition file and add your module's requirements and other options as appropriate (start by replacing the TODO: ... parts):

{
  "general": {
    "url": "TODO: https://full.link.to/your/project",
    "authors": "TODO: First Last <first.last@example.org>"
  },
 
  "update": {
    "git": {
      "h2t_gitlab_slug": "TODO: the/path/to/your/gitlab/project/after/git.h2t.iar.kit.edu/"
    }
  },
 
  "prepare": {
    "cmake": {
      "definitions": {
        "CMAKE_C_COMPILER": "$ARMARX_C_COMPILER",
        "CMAKE_CXX_COMPILER": "$ARMARX_CXX_COMPILER"
      }
    }
  },
 
  "build": "cmake",
 
  "required_modules": {
    "armarx/meta/compiler": {},
    "armarx/ArmarXCore": {}
  }
}

In case you intend to use python within your package, extend the module as follows:

{
  ...
 
  "prepare": {
    ...,
    "python": {
      "packages": {
        "TODO: the/path/to/the/python/module/e.g./python/your_module": {
          "python": "python-3.10"
        }
      }
    }
  },
 
  "build": ...,
 
  "install": {
    "env": {
      "python3_armarx_PYTHON_PACKAGE_DIR": "$MODULE_PATH"
    }
  },
 
  "required_modules": {
    ...,
    "tools/python/3.10": {}
  }
}