Making an MDAKit

The MDAKit registry has a number of requirements to ensure that registered packages are FAIR-compliant and hold up to an ideal scientific standard.

Building a Kit using the cookiecutter

Without prior experience, some of the MDAKit Registry requirements can be daunting. The MDAKit cookiecutter can be used to aid rapid development of a FAIR-compliant MDAKit by generating placeholder code for documentation, testing and installation. A guided example of creating an MDAKit, from cookiecutter to registration, is provided below.

• Guided Example: Building an RMSF analysis Kit
  • Part 1: Using the MDAKit cookicutter
  • Part 2: Adding code
  • Part 3: Adding tests
  • Part 4: Pushing to GitHub
  • Part 5: Providing documentation
  • Part 6: Making an initial release
  • Part 7: Registering an MDAKit

Building without the cookiecutter (or from an existing project)

If you have an existing package you wish to register as an MDAKit, or if you wish to develop a Kit without use of the cookiecutter, that’s also okay! For existing code, chances are very little restructuring is required before registration - just make sure you meet the core requirements for registration.

You may still find the above links helpful, along with the additional information below.

• Licensing
• Hosting code in a version controlled repository
• Testing
• Documentation