Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cylc/cylc-rose

A Cylc plugin providing support for the Rose rose-suite.conf file.

https://github.com/cylc/cylc-rose

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

cylc cylc-plugin rose

Keywords from Contributors

scheduler cycling-workflows job-scheduler metascheduler workflow-automation workflow-engine workflow-management archival projection profiles
Last synced: 6 months ago · JSON representation

Repository

A Cylc plugin providing support for the Rose rose-suite.conf file.

Basic Info
Statistics
  • Stars: 8
  • Watchers: 5
  • Forks: 12
  • Open Issues: 18
  • Releases: 22
Topics
cylc cylc-plugin rose
Created over 5 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License

README.md

Cylc-Rose Plugin

PyPI tests Codecov

A Cylc plugin providing support for the Rose rose-suite.conf file.

For use with Cylc 8 and Rose 2.

Installation

Install from PyPi:

pip install cylc-rose

Or Conda:

conda install cylc-rose

No further configuration is required, Cylc will load this plugin automatically.

Overview

In the past Rose provided a wrapper to Cylc providing additional capabilities including workflow installation.

As of Cylc 8 and Rose 2 some of this functionality has been re-built directly in Cylc, the rest has been migrated into this Plugin.

The last versions of Cylc and Rose which use the wrapper are:

  • Cylc 7
  • Rose 2019

For all later versions please install this plugin into your Cylc/Rose environment for Rose integration.

What This Plugin Does

This plugin provides support for the rose-suite.conf file, namely:

  • Jinja2 template variables.
  • Scheduler environment variables.
  • File installation.
  • Optional configurations.

What This Plugin Does Not Do

  • Support the root-dir* configurations, these have been deprecated by the new Cylc symlink dirs functionality.
  • Graphical configuration editors.

How It Works

For developer documentation, see DEVELOPING.

Contributing

Contributors Commit activity Last commit

Note: If also developing Cylc and or Rose you may wish to install cylc-rose in the same environment before installing cylc-rose.

pip install -e cylc-rose[all]

Copyright and Terms of Use

License

Copyright (C) 2008-2025 NIWA & British Crown (Met Office) & Contributors.

Cylc-rose is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Cylc-rose is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Cylc-rose. If not, see GNU licenses.

Owner

  • Name: The Cylc Workflow Engine
  • Login: cylc
  • Kind: organization
  • Email: hilary.oliver@niwa.co.nz
  • Location: Wellington, New Zealand

A workflow engine for cycling systems.

GitHub Events

Total
  • Create event: 20
  • Release event: 3
  • Issues event: 5
  • Watch event: 1
  • Delete event: 22
  • Issue comment event: 26
  • Push event: 35
  • Pull request event: 69
  • Pull request review event: 71
  • Pull request review comment event: 42
  • Fork event: 1
Last Year
  • Create event: 20
  • Release event: 3
  • Issues event: 5
  • Watch event: 1
  • Delete event: 22
  • Issue comment event: 26
  • Push event: 35
  • Pull request event: 69
  • Pull request review event: 71
  • Pull request review comment event: 42
  • Fork event: 1

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 386
  • Total Committers: 10
  • Avg Commits per committer: 38.6
  • Development Distribution Score (DDS): 0.472
Past Year
  • Commits: 52
  • Committers: 5
  • Avg Commits per committer: 10.4
  • Development Distribution Score (DDS): 0.654
Top Committers
Name Email Commits
Tim Pillinger t****r@m****k 204
Oliver Sanders o****s@m****k 70
Ronnie Dutta r****a@m****k 45
github-actions[bot] g****s@n****m 34
dependabot[bot] 4****] 19
Hilary Oliver h****r@g****m 6
Mel Hall m****l@m****k 5
Mark Dawson m****n@m****k 1
Jonny Williams j****w 1
Bruno Kinoshita k****w@a****g 1
Committer Domains (Top 20 + Academic)
metoffice.gov.uk: 5 apache.org: 1 no-reply.github.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 29
  • Total pull requests: 226
  • Average time to close issues: 4 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 6
  • Total pull request authors: 6
  • Average comments per issue: 1.24
  • Average comments per pull request: 1.12
  • Merged pull requests: 180
  • Bot issues: 0
  • Bot pull requests: 90
Past Year
  • Issues: 2
  • Pull requests: 57
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 days
  • Issue authors: 2
  • Pull request authors: 5
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.49
  • Merged pull requests: 45
  • Bot issues: 0
  • Bot pull requests: 36
View more stats
Top Authors
Issue Authors
  • oliver-sanders (12)
  • wxtim (11)
  • ColemanTom (2)
  • hiker (1)
  • meteorpaul (1)
  • dpmatthews (1)
Pull Request Authors
  • wxtim (83)
  • github-actions[bot] (80)
  • dependabot[bot] (48)
  • oliver-sanders (46)
  • MetRonnie (30)
  • datamel (1)
Top Labels
Issue Labels
bug (8) enhancement (3) good first issue (2) question (2) infrastructure (1) documentation (1) small (1)
Pull Request Labels
infrastructure (63) small (62) dependencies (51) sync (35) bug (26) release (22) documentation (5) enhancement (5) duplicate (1) refactor (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
conda-forge.org: cylc-rose

Cylc Rose is a replacement for the rose suite-run command (present in Rose versions 2019.01 and earlier). It reads the rose-suite.conf file and performs the required actions.

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Forks count: 43.4%
Average: 46.7%
Dependent packages count: 51.2%
Stargazers count: 58.4%
Last synced: 6 months ago

Dependencies

.github/workflows/1_create_release_pr.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • cylc/release-actions/build-python-package v1 composite
  • cylc/release-actions/check-shortlog v1 composite
  • cylc/release-actions/stage-1/checkout-pr-branch v1 composite
  • cylc/release-actions/stage-1/create-release-pr v1 composite
  • cylc/release-actions/stage-1/sanitize-inputs v1 composite
  • cylc/release-actions/stage-1/set-python-package-version v1 composite
  • cylc/release-actions/stage-1/update-changelog-release-date v1 composite
.github/workflows/2_auto_publish_release.yml actions
  • actions/checkout v3 composite
  • actions/create-release v1 composite
  • actions/setup-python v4 composite
  • cylc/release-actions/build-python-package v1 composite
  • cylc/release-actions/stage-2/bump-dev-version v1 composite
  • cylc/release-actions/stage-2/comment-on-pr v1 composite
  • cylc/release-actions/stage-2/get-version-from-pr v1 composite
  • pypa/gh-action-pypi-publish v1.6.4 composite
.github/workflows/shortlog.yml actions
  • actions/checkout v3 composite
  • cylc/release-actions/check-shortlog v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/update_copyright.yml actions
  • actions/checkout v3 composite
  • cylc/release-actions/checkout-copyright-branch v1 composite
  • cylc/release-actions/configure-git v1 composite
  • cylc/release-actions/create-pr v1 composite