Software checklist

For things you install and run: libraries, command-line tools and desktop applications. The ladder runs from working code through engineering practice and a published release to the EBRAINS Software Distribution and the Lab.

Service types: cli, desktop, library · Rubric: EBRAINS default, version x4

How to read it: a level is reached when all of its conditions are met, and levels are climbed in order. Waived conditions are not required yet and are always shown as waived. A condition can be marked not applicable for a service (a status page cannot monitor itself); it then drops out of the level.

TRL 1 · Project initiation

• Technology principles and high-level objectives are defined
  Met when any of:
  • Service description recorded
  • Owner contact recorded
• Use case definitions, target users and supporting references
  Met when any of:
  • Use case recorded
  • Intended users recorded
  • Research backing recorded
  • Related publications recorded
  • Ethical aspects recorded

TRL 2 · Conceptualisation

• Practical applications identified; proof of concept planned
  Met when any of:
  • Intended users recorded
  • Use case recorded
  • Repository accessible
  • Primary repository URL recorded

TRL 3 · Proof of concept implementation

• Software components exist and are validated separately
  Met when any of:
  • Repository accessible
  • Primary repository URL recorded

TRL 4 · Prototype component

• Key modules integrated and functionally validated (alpha prototype)
  Met when any of:
  • Continuous integration more than 0
  • Test types recorded
  • Containerised
  • Release count at least 1
• Initial architecture documentation available
  Met when any of:
  • README quality: basic, good or comprehensive
  • Knowledge Graph documentation URL recorded
  • Documentation strategy recorded

TRL 5 · Prototype integration

• End-to-end software integrated and interfaced with the target environment
  Met when any of:
  • Release count at least 1
  • Spack package present recorded
  • Lab deployed
• All required data formats have been specified
  Waived — No collector can observe a data-format specification; declare it in a catalogue rule when the owner provides it.

TRL 6 · Pilot-scale prototype to real-world integration

• Tested in a relevant environment under expected load
  Met when any of:
  • Spack package present recorded
  • Lab deployed
• Initial system, user and final architecture documentation available
  Met when any of:
  • README quality: good or comprehensive
  • Knowledge Graph documentation URL recorded
  • Documentation strategy recorded

TRL 7 · Operational integration

• Validated with all key functionality in a relevant real-world environment; well integrated with operational systems
  Met when: Lab deployed.
• No expected data format or API changes; final design virtually complete
  Met when any of:
  • API stability: stable
  • Semantic versioning recorded
  • Tagging conventions recorded
• Most software bugs removed (active bug tracking)
  Met when: Issue tracking recorded.

TRL 8 · Deployment

• All user documentation completed
  Met when any of:
  • Knowledge Graph documentation URL recorded
  • README quality: good or comprehensive
  • Documentation strategy recorded
• Training documentation and tutorials completed
  Met when any of:
  • KG learning resources count at least 1
  • Knowledge Graph documentation URL recorded
  • README quality: comprehensive
• Thoroughly tested (user-acceptance and performance) and debugged
  Met when any of:
  • Test types recorded
  • Code coverage recorded
• Tested in a real-world environment with a small number of real users
  Met when any of:
  • Lab deployed
  • Users count more than 0
  • KG developer count at least 2

TRL 9 · Production

• Final form operated under the full range of operating conditions with a target number of real users
  Met when all of:
  • Lab deployed
  • Release count at least 1
• Sustaining software engineering support in place
  Met when any of:
  • Support channels recorded
  • Issue tracking recorded
• Actively maintained
  Met when any of:
  • Maintainer count at least 1
  • Has maintainer recorded
  • Commit frequency recorded

Generated from the rubric Ready evaluates. Organisations can assess their own catalogues against their own rubric in Ready; those results are labelled as such and are not the EBRAINS default.