Hosting code in a version controlled repository

The MDAKits registry makes heavy use of the GitHub actions infrastructure. Thus, registration of a kit requires that all code maintainers also have a GitHub account for communication purposes.

For this reason, if your code is not already hosted in an accessible version controlled repository, hosting on GitHub is recommended, although other services such as Bitbucket, GitLab, or self hosting are possible.

The registry does not require that your code be available through packaging repositories such as the Python Package Index (PyPi) or conda-forge, although having your code available through these services is highly encouraged.

However, your code does need to be installable from source. You’ll specify the commands for this in the src_install field of your metadata.yaml file (see the metadata.yaml documentation). This will then be made available to users on your MDAKit’s page on the Registry.