This repository contains the source code of the official App registry for the AiiDA lab.

1. Add a metadata.json file to your app repository. Example:

       {
           "title": "AiiDA Tutorials",
           "description": "Learn how to use AiiDA using jupyter notebooks on the AiiDA lab.",
           "version": "0.1-alpha",
           "authors": "A. Person, B. Smart",
           "logo": "folder/logo.png",
           "state": "development",
           "documentation_url": "https://aiidalab-exmpl.readthedocs.io",
           "external_url": "http://www.aiida.net"
       }

   Note: The fields title and description are mandatory.

   Note: If you used the AiiDA lab App cookie cutter to create your app, you should already have metadata.json in your repository and need only update it.

2. Fork this repository.

3. Make a pull request that adds your app to the apps.json file. Example:

       "aiida-tutorials": {
           "git_url": "https://github.com/aiidateam/aiida_demos.git",
           "meta_url": "https://raw.githubusercontent.com/aiidateam/aiida_demos/master/metadata.json",
           "categories": ["tutorials"]
       }

Your app will show up in the AiiDA lab App Store once your pull request is merged.

The title will be displayed in the list of apps in the application manager.

The description will be displayed on the detail page of your app.

The version will be displayed on the detail page of your app. This is also used by the AiiDA lab App Store.

Comma-separated list of authors.

Relative path to a logo (png or jpg) within your repository.

One of

• registered: lowest level - app may not yet be in a working state. Use this to secure a specific name.
• development: app is under active development, expect the occasional bug.
• stable: app can be used in production.

The link to the online documentation of the app (e.g. on Read The Docs).

General homepage for your app.

Mandatory. Link to the source code repository.

Mandatory. Link to the location of your app's metadata.json file.

Optional. List of valid categories.

You can see the most recent list of categories in categories.json, including a description of each category.

This work is supported by the MARVEL National Centre for Competency in Research funded by the Swiss National Science Foundation, as well as by the MaX European Centre of Excellence funded by the Horizon 2020 EINFRA-5 program, Grant No. 676598.