Skip to content

Commit

Permalink
[USGS-R#146] rm redundant text in workflow readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jsadler2 authored Jan 21, 2022
1 parent 781ce59 commit a942fe4
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions workflow_examples/readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
## Intro
The Snakefiles and associated config files in this directory are meant to provide examples of Snakemake workflows that use river-dl functionality. Snakemake is a very flexible and useful tool and these are just a few examples of how it can be used. For more information about Snakemake, please see the Snakemake docs which are very comprehensive and helpful. A link to the documents is below.

Hopefully these can serve as examples, but also hopefully you are thinking about what works best for _your_ follow or depart from these examples accordingly:
The Snakefiles and associated config files in this directory are meant to provide examples of Snakemake workflows that use river-dl functionality. Hopefully these can serve as examples, but also hopefully you are thinking about what works best for _your_ follow or depart from these examples accordingly:
- You will need to modify some things if you want to use these workflows for your own purposes. See "What might change when you make your own workflow" section below for more details on what and where you might modify.
- There are _many_ ways that snakemake could be used with river-dl to execute these workflows. If you want to learn more about the basics of snakemake, we recommend checking out their [tutorial](https://snakemake.readthedocs.io/en/stable/tutorial/tutorial.html) and their [comprehensive docs](https://snakemake.readthedocs.io/en/stable/).
- There are also many ways that river-dl can be used _without_ snakemake. For example, you could simply use a Python file to call different river-dl functions. This option generally trades robustness and scalability for expediency.
Expand Down

0 comments on commit a942fe4

Please sign in to comment.