Skip to content

Add statistics & figures about features & usage #16

@sadielbartholomew

Description

@sadielbartholomew

Towards improving certain sections, notably the Features & Users pages, I think we could promote Cylc by incorporating carefully selected figures relating to these aspects.

I thought this merits its own Issue to e.g. #11 since it may require some discussion as to:

  • which figures are best to include (we don't want to include too many, I think, just highlight the ones which are especially impressive), possibilities being for example the number of:
    • institutions using Cylc, &/or the years they have been in use there;
    • batch systems (directly) supported: 8, according to the docs;
    • diagrams &/or code examples contained in the docs (see example below, & also the final bullet in the opening comment of Include, rather than write in, significant code examples cylc-doc#67 (comment));
    • cylc commands;
    • suite.rc configuration settings.
    • approaches for grouping & consolidating suite configuration (parameters, templating via Jinja2 or EmPy, families): 3
  • illustrative numbers of lines of code required to achieve basic suite setups (which should be small).
  • how we can keep such figures up-to-date. Note:
    • if possible we ideally could extract these figures automatically, but if not we should have a review period to check & update them as appropriate.
    • we could always provide a bound rather than a hard figure, e.g. 'more than 70' / '70+'.

Examples

Other projects quote impressive figures about their projects on their project homepages to good effect. Some examples are captured in screenshots below:

ZeroMQ:

ZMQ_scr

AWS:

aws_scr

Dash:

scr_dash

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions