Skip to main content

A workflow engine for cycling systems

Project description

PyPI Anaconda-Server Badge chat forum Documentation

Cylc (pronounced silk) is a general purpose workflow engine that also manages cycling systems very efficiently. It is used in production weather, climate, and environmental forecasting on HPC, but is not specialized to those domains.

Quick Start

Installation | Documentation

# install cylc
conda install cylc-flow

# extract an example to run
cylc get-resources examples/integer-cycling

# install and run it
cylc vip integer-cycling  # vip = validate, install and play

# watch it run
cylc tui integer-cycling

The Cylc Ecosystem

  • cylc-flow - The core Cylc Scheduler for defining and running workflows.
  • cylc-uiserver - The web-based Cylc graphical user interface for monitoring and controlling workflows.
  • cylc-rose - Provides integration with Rose.

Migrating From Cylc 7

Migration Guide | Migration Support

Cylc 8 can run most Cylc 7 workflows in compatibility mode with little to no changes, go through the migration guide for more details.

Quick summary of major changes:

  • Python 2 -> 3.
  • Internal communications converted from HTTPS to ZMQ (TCP).
  • PyGTK GUIs replaced by:
    • Terminal user interface (TUI) included in cylc-flow.
    • Web user interface provided by the cylc-uiserver package.
  • A new scheduling algorithm with support for branched workflows.
  • Command line changes:
    • cylc run <id> -> cylc play <id>
    • cylc restart <id> -> cylc play <id>
    • rose suite-run -> cylc install; cylc play <id>
  • The core package containing Cylc scheduler program has been renamed cylc-flow.
  • Cylc review has been removed, the Cylc 7 version remains Cylc 8 compatible.

Citations & Publications

DOI JOSS CISE

Copyright and Terms of Use

License

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

Cylc 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 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. If not, see GNU licenses.

Contributing

Contributors Commit activity Last commit

Contributions welcome:

This repository contains some code that was generated by GitHub Copilot.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cylc_flow-8.4.3.tar.gz (797.5 kB view details)

Uploaded Source

Built Distribution

cylc_flow-8.4.3-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file cylc_flow-8.4.3.tar.gz.

File metadata

  • Download URL: cylc_flow-8.4.3.tar.gz
  • Upload date:
  • Size: 797.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cylc_flow-8.4.3.tar.gz
Algorithm Hash digest
SHA256 b74a0feb9489e2a3489e8dfa81fc8593311d96b7c9d115af70e76aff63a6ac8b
MD5 6d49bcae6e5d7d1ef33db6f5a91e673e
BLAKE2b-256 ae11da9ce4304c0b4643ebc683bc8c97b554c8b5167e58a074c7399cdf47fb97

See more details on using hashes here.

File details

Details for the file cylc_flow-8.4.3-py3-none-any.whl.

File metadata

  • Download URL: cylc_flow-8.4.3-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cylc_flow-8.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dc3744923d41730a469a0f90bdd170ce49808ccee7a85c58708b0221cd193f19
MD5 ce57e35e2a235c40acc856d790e54f40
BLAKE2b-256 c034b7818e952a5a22b3f752afa1937c23d0b2a8c9e37375edb0ef92961ebc51

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page