aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2025-01-28 21:47:28 +0000
committerArun Isaac2025-01-28 21:47:28 +0000
commitcd65c094e50bc66ecf72e9b1b8b1ca6f568a11a9 (patch)
treee98bc204ab210b74a1cb177409a9208598066c80
parentdb2e427273d1fea7a2c4d94e8dea72aa1df50435 (diff)
downloadravanan-cd65c094e50bc66ecf72e9b1b8b1ca6f568a11a9.tar.gz
ravanan-cd65c094e50bc66ecf72e9b1b8b1ca6f568a11a9.tar.lz
ravanan-cd65c094e50bc66ecf72e9b1b8b1ca6f568a11a9.zip
README: Mention use of caching for developing workflows.
* README.md: Mention use of caching for developing workflows.
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0f44553..4c566ef 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
ravanan (pronounced rah-vun-un, IPA: rɑːvʌnʌn, Shavian: 𐑮𐑭𐑝𐑳𐑯𐑳𐑯) is a [Common Workflow Language (CWL)](https://www.commonwl.org/) implementation that is powered by [GNU Guix](https://guix.gnu.org/) and provides strong reproducibility guarantees. ravanan provides strong bullet-proof caching ([work reuse](https://www.commonwl.org/v1.2/CommandLineTool.html#WorkReuse)) so you never run the same step of your workflow twice, nor do you have to keep track of which steps were run and with what parameters: ravanan remembers everything for you. ravanan captures logs from every step of your workflow so you can always trace back in case of job failures.
Salient features of ravanan include:
-- Bullet-proof caching; never run the same computation again and never fear that the cache is stale (no kidding, we're serious!)
+- Bullet-proof caching; never run the same computation again and never fear that the cache is stale (no kidding, we're serious!). This is especially useful when developing a workflow and you want to iterate by repeatedly running slightly modified workflows.
- Each step in your CWL corresponds to exactly one job on the batch system.
- Clear logging; you never have to hunt for log files in obscure directories or binary databases.
- Jobs do not directly write to the shared network filesystem; keeps performance good and your fellow HPC users happy