applications

HoloHub Applications

This directory contains applications based on the Holoscan Platform. Some applications might require specific hardware and software packages which are described in the metadata.json and/or README.md for each application.

Contributing to HoloHub Applications

Please review the CONTRIBUTING.md file guidelines to contribute applications.

HoloHub Application Organization Conventions

Starting a New Project with HoloHub CLI (Recommended)

Use the HoloHub CLI tool when starting a new project to generate a project folder with files in compliance with HoloHub conventions out of the box.

./holohub create

Required Conventions

We expect that an application contributed to HoloHub conforms to the following organization:

• Each project must provide a metadata.json file reflecting several key components such as the application name and description, authors, dependencies, and the primary project language.
• Each project must provide a README or README.md file.
  • We strongly recommend that the project README file provides at least the information given in the template README, including the project description and a splash image.
• Each project must be organized in its own subfolder under holohub/applications/.

See the HoloHub application template for example README and metadata.json documents to get started.

Recommended Conventions

Contributors may additionally opt to lay out their project structure in a way that conforms to HoloHub conventions in order to enable common infrastructure for their project, including streamlined build and run support in the holohub script and search support on the HoloHub landing page.

HoloHub recommended application convention is as follows:

• Languages
  • Project is either C++ or Python language
  • If multiple language implementations are provided, each must be added to its own language subfolder as follows:

applications/
  └── my_project/
        ├── cpp/
        │     ├── ...
        │     └── ...
        └── python/
              ├── ...
              └── ...

• Container Environment

  • Project may provide its own container environment or opt to use the default HoloHub environment
  • If the project specifies its own container:
    • Default project environment must be named Dockerfile
    • Project Dockerfile must be located at either:
      • The same directory as metadata.json, or
      • The project may provide an alternative default Dockerfile path in metadata.json
  • If the project does not specify a Dockerfile then the default HoloHub Dockerfile will be used

• Build and Run Instructions

  • Must provide a run command in metadata.json for ./holohub run to reference
  • Must otherwise comply with ./holohub run command options for the default use case
  • Advanced instructions may also be specified in the project README