Docs
Search…
Module Guidelines
In this section you can read about guidelines that will improve your module, ensure its intercompatibility with (public) modules in a workflow and boost the likeliness of its public usage.

Module Guidelines for...

... developing your module

  • Make sure to use the latest available and stable libraries in order to increase compatibility and decrease security issues
  • Default in- and output type should be "File"
  • The meta data of an image should be conserved during an image processing step
  • Each Module needs to have labels and descriptions for all in- and outputs
  • DO NOT use the "-" character inside input/output names.
  • CSV-files should be used for non-image data in- and outputs of modules (separate by ",")
  • In- and output file format of image processing modules should be identical (e.g. .ome.tiff in, .ome.tiff out)
  • All supported file formats of a module should be specified in the JSON (not just .ome.tiff)

... publishing your module on APEER

  • Write a short summary in the module description on APEER
  • Make sure that your module can use different file formats (e.g. for images: .ome.tiff or .jpg or .png)
  • For image processing modules OME-TIFF is recommended as standard image file format on our platform
  • Help other developers to understand your module by writing a self-explaining technical documentation in the README.md file within your project (only necessary when source code will be open accessible)
  • List all the licenses of third party artifacts (libraries, frameworks etc.) e.g. in a LICENSE.md file within your project
Note that public modules might not only be hosted and provided through the APEER platform itself (network service), but also on-premise (creating a copy, distribution in its classic sense).
It is your responsibility to assure license compatibility of any software that is part of your module. For guidance on the requirements of the different FOSS license see for example TLDRLegal or Open Source Guide or Choose a License. Of course we will support you in finding the right license for your module: [email protected]

You couldn't find all the information you need? Contact us!

If you need help, just check out our FAQ. For any further questions please contact us at [email protected] or have a look at How-tos section in our blog or follow us on Twitter to stay up to date.
Last modified 2yr ago