https://github.com/cylc/cylc-flow
Cylc: a workflow engine for cycling systems.
https://github.com/cylc/cylc-flow
cycling-workflows cylc hacktoberfest job-scheduler metascheduler python scheduler scheduling workflow workflow-automation workflow-engine workflow-management
Last synced: 6 days ago
JSON representation
Cylc: a workflow engine for cycling systems.
- Host: GitHub
- URL: https://github.com/cylc/cylc-flow
- Owner: cylc
- License: gpl-3.0
- Created: 2011-06-02T08:31:49.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T11:42:26.000Z (6 months ago)
- Last Synced: 2024-10-29T13:27:40.425Z (6 months ago)
- Topics: cycling-workflows, cylc, hacktoberfest, job-scheduler, metascheduler, python, scheduler, scheduling, workflow, workflow-automation, workflow-engine, workflow-management
- Language: Python
- Homepage: https://cylc.github.io
- Size: 124 MB
- Stars: 330
- Watchers: 15
- Forks: 93
- Open Issues: 481
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Security: SECURITY.md
Awesome Lists containing this project
- awesome_ai_agents - Cylc-Flow - Cylc - a workflow engine for cycling systems. (Building / Workflows)
- awesome_ai_agents - Cylc-Flow - Cylc - a workflow engine for cycling systems. (Building / Workflows)
README
[](https://pypi.org/project/cylc-flow/)
[](https://anaconda.org/conda-forge/cylc-flow)
[](https://matrix.to/#/#cylc-general:matrix.org)
[](https://cylc.discourse.group/)
[](https://cylc.github.io/cylc-doc/stable/html/index.html)
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](https://cylc.github.io/cylc-doc/stable/html/installation.html) |
[Documentation](https://cylc.github.io/cylc-doc/stable/html/index.html)
```bash
# 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](https://github.com/cylc/cylc-flow) - The core Cylc Scheduler for defining and running workflows.
- [cylc-uiserver](https://github.com/cylc/cylc-uiserver) - The web-based Cylc graphical user interface for monitoring and controlling workflows.
- [cylc-rose](https://github.com/cylc/cylc-rose) - Provides integration with [Rose](http://metomi.github.io/rose/).
### Migrating From Cylc 7
[Migration Guide](https://cylc.github.io/cylc-doc/stable/html/7-to-8/index.html)
| [Migration Support](https://cylc.discourse.group/c/cylc/7-to-8/13)
Cylc 8 can run most Cylc 7 workflows in compatibility mode with little to no
changes, go through the
[migration guide](https://cylc.github.io/cylc-doc/stable/html/7-to-8/index.html)
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 ` -> `cylc play `
* `cylc restart ` -> `cylc play `
* `rose suite-run` -> `cylc install; cylc play `
* 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
[](https://zenodo.org/badge/latestdoi/1836229)
[](https://doi.org/10.21105/joss.00737)
[](https://ieeexplore.ieee.org/document/8675433)
### Copyright and Terms of Use
[](https://github.com/cylc/cylc-flow/blob/master/COPYING)
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](http://www.gnu.org/licenses/).
### Contributing
[](https://github.com/cylc/cylc-flow/graphs/contributors)
[](https://github.com/cylc/cylc-flow/commits/master)
[](https://github.com/cylc/cylc-flow/commits/master)
Contributions welcome:
* Read the [contributing](https://github.com/cylc/cylc-flow/blob/master/CONTRIBUTING.md) page.
* Development setup instructions are in the
[developer docs](https://cylc.github.io/cylc-admin/#cylc-8-developer-docs).
* Involved change proposals can be found in the
[admin pages](https://cylc.github.io/cylc-admin/#change-proposals).
* Touch base in the
[developers chat](https://matrix.to/#/#cylc-general:matrix.org).
This repository contains some code that was generated by GitHub Copilot.