Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated name for convenience.

...

We have this ongoing task 

Jira
serverJIRA
serverIdb14d4ad9-eb00-3a94-88ac-a843fb6fa1ca
keyBD-736
 and will tentatively use the name "Brown Dog Transformations" (previously suggested by Ben) or "BD Transformations" in short as we describe Tools Catalog "2.0" on this page. For the remaining part of this document we will use BD Transformations in place of Tools Catalog 2.0. This will help clarify thoughts related to Tool vs Software.

Definitions

This section will define the main concepts that will need to be clearly understood for easily interacting with the Tools CatalogBD Transformations. An example can be Tool Software vs Script Transformation or any new terminology that will be used in Tools CatalogBD Transformations.

Converter: Software Program that does data format conversion.

Extractor: Software that Program that process and extract metadata from data.

Transformation: Any converter or extractor or extractor program.

Software: Software tool / library that is used by an extractor or converter to do data transformation.

...

Minimum Viable Product (MVP): Version of Tools Catalog 2.0 BD Transformations with only a few basic features. This will be developed through some kind of a hackathon.

User Roles

The user roles in the Tool Catalog 2.0 BD Transformations will be:

  1. Administrator
    1. Update / Delete transformations created by contributors
    2. Update / Delete tools added software added by contributors?
    3. All Viewer permissions
  2. Contributor
    1. Create new transformation and link it to one or more existing software.
    2. Add a new software to the Tools CatalogBD Transformations
    3. Update created transformations [adding the word "created" to make it clear that a contributor can only manage the transformations they contributed]
    4. Delete created transformations
    5. View created transformations
    6. All Viewer permissions
  3. Viewer (can be any user who does not login)
    1. View all transformations
    2. View all software

...

  • All users can view all transformations that are linked to a software.
  • All users can view a single transformation and the software that it uses.
  • Contributors will be able to add a transformation through the Tools Catalog interfaceBD Transformations interface.
    • This will be made available through a form that the contributor can fill and submit.
    • Ability to include icon
    • Ability to include link to software web page (e.g. Image JImageJ)
    • Ability to add a URL to the transformation  - source code / docker image name / website
  • Contributors will also be able to import a new transformation into the catalog by uploading an extractors_info.json or converters_info.json file.
    • Any missing piece of information can be filled in by the contributor.
  • Contributors will be able to link their transformation with one more existing software in the Tools CatalogBD Transformations. They will be able to add a new tool software if it doesn't already exist in BD Transformations.
  • There won't be any formal approval process for the submitted transformations. All transformations that get submitted will be available to the public.
  • Administrators can update or delete any transformation as they feel appropriate.

...

  • Flask Templates
  • Bootstrap
  • JQuery
  • Flask Services
    • POST <extractors/converters>_info.json to MongoDB
    • GET <extractors/converters>_info.json for a specific transformation
    • GET all transformations
    • GET all transformations that uses a specific software
  • MongoDB
  • LDAP Library
    • Code to talk to NCSA LDAP for authentication
  • Clusterman endpoint to read from Tools Catalog 2.0 BD Transformations database.