You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/EDITING.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -29,11 +29,11 @@ Instructions for editing specific pages and site components.
29
29
<aid="navigation-menus"></a>
30
30
## Navigation Menus
31
31
32
-
There are two nav menu templates currently available:
32
+
There are two nav menu templates currently available:
33
33
34
34
*`_includes/top_nav.html` - the main site nav
35
35
* Data: `_data/navigation.yml`
36
-
*Syles: `_sass/partials/_nav.scss`
36
+
*Styles: `_sass/partials/_nav.scss`
37
37
*`_includes/left_nav.html` - left nav on an individual page
38
38
* Data: `_data/navigation.yml` by default
39
39
* Can also pull data from a page-specific file, e.g. `gallery.html` previously used `_data/user-gallery.yml` for its left nav
@@ -141,7 +141,7 @@ The first version will generate `<body class="body-page-short">`, and the second
141
141
* `_includes/home/intro.html` - contains the intro paragraph and imports the video player
142
142
* `_includes/home/features.html` - template for the "Features" boxes section. Relies on `_data/home.yml`
143
143
* `_includes/home/users-mini-gallery.html` - the bottom gallery of logos. Relies on data in `_data/user-gallery.html`
144
-
* `_includes/home/video-player.html` - template code for the video player ([Plyr](https://plyr.io/)). See [Video Player](#video-player) section for more info.
144
+
* `_includes/home/video-player.html` - template code for the video player ([Plyr](https://plyr.io/)). See [Video Player](#video-player) section for more info.
145
145
146
146
<a id="features-boxes"></a>
147
147
#### Features Boxes
@@ -293,7 +293,7 @@ Items containing special characters (colons, brackets, etc) may need to be wrapp
293
293
<a id="foreign-languages"></a>
294
294
## Foreign Languages
295
295
296
-
Text in foreign language should be entered in HTML and include the `lang` and `hreflang` attributes. Subtitles should include the `srclang` code Here's a list of [common language subtags](https://en.wikipedia.org/wiki/IETF_language_tag#List_of_subtags) You can also search via [the Language Subtag Lookup](https://r12a.github.io/app-subtags/) or check whether a tag is valid (e.g. `en-us` is valid, while `en_us` is not).
296
+
Text in foreign language should be entered in HTML and include the `lang` and `hreflang` attributes. Subtitles should include the `srclang` code Here's a list of [common language subtags](https://en.wikipedia.org/wiki/IETF_language_tag#List_of_subtags) You can also search via [the Language Subtag Lookup](https://r12a.github.io/app-subtags/) or check whether a tag is valid (e.g. `en-us` is valid, while `en_us` is not).
* A series of <a href="https://stepik.org/lesson/35918/step/1?unit=15070"lang="ru" hreflang="ru"> is available
315
+
* A series of <a href="https://stepik.org/lesson/35918/step/1?unit=15070"lang="ru" hreflang="ru"> is available
316
316
in Russian as part of the <a href="https://stepik.org/course/1612/syllabus" lang="ru">Управление вычислениями</a
317
317
> (Computation Management) free online course.
318
318
```
@@ -324,7 +324,7 @@ Currently the site has some Japanese & Russian links. The corresponding codes ar
324
324
325
325
For any markdown tables, prepend the following classes: `.table`, `.table-striped`, `.cols-2` or `.cols-3`:
326
326
327
-
2 Column Table Example:
327
+
2 Column Table Example:
328
328
329
329
```markdown
330
330
{: .table .table-striped .cols-2 }
@@ -343,14 +343,14 @@ For 3 column table, change `.cols-2` to `.cols-3`. i.e. `{: .table .table-stripe
343
343
* Bootstrap 5.1.3
344
344
* Site styles are built on top of Bootstrap 5.1.3
345
345
* Nav menu relies on `/assets/js/bootstrap.min.js`
346
-
* jQuery 3.5.1
346
+
* jQuery 3.5.1
347
347
* Mobile Nav relies on this in `/assets/js/navCloseFix.js`, due to a bug where it wasn't closing properly
348
348
* Back to the Top button relies on this
349
349
350
350
<a id="bootstrap"></a>
351
351
### Bootstrap
352
352
353
-
The site uses [Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/) (specifically v5.0.0-beta3) for the base styles, and the nav menus.
353
+
The site uses [Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/) (specifically v5.0.0-beta3) for the base styles, and the nav menus.
354
354
355
355
Relevant folders & files:
356
356
@@ -362,7 +362,7 @@ The styles are loaded as the first import in `style.scss`. The JS code is loaded
362
362
<a id="media-query-grid-breakpoints"></a>
363
363
#### Media Query Grid Breakpoints
364
364
365
-
Bootstrap grid breakpoints are originally found in ``_sass/bootstrap/_variables.scss`, and can be overriden in `_sass/partials/_variables.scss`
365
+
Bootstrap grid breakpoints are originally found in ``_sass/bootstrap/_variables.scss`, and can be overridden in `_sass/partials/_variables.scss`
366
366
367
367
The following breakpoints and max-widths are used for responsive design:
Copy file name to clipboardExpand all lines: content/README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# CWL Website - Instructions
2
2
3
-
Instructions on how to run and edit the main [commonwl.org](commonwl.org) website.
3
+
Instructions on how to run and edit the main [commonwl.org](commonwl.org) website.
4
4
5
5
See the main [README.md](../README.md) for general [instructions](../README.md#contributing) on contributing. See the [Security Policy](https://github.com/common-workflow-language/cwl-website/security/policy) page to report a vulnerability.
6
6
@@ -54,7 +54,7 @@ It's important to specify both config files, in order. Otherwise Jekyll will gen
54
54
55
55
**Use a custom url or port:** For convenience, you may wish to specify `--host cwl.test` and `--port 80` (or any other value), as follows: `bundle exec jekyll serve --config "_config.yml,_config_local.yml --host cwl.test --port 80`. **Note:** You may have to [update your hosts file](https://www.howtogeek.com/howto/27350/beginner-geek-how-to-edit-your-hosts-file/), in order for your computer to respect the custom url.
56
56
57
-
**Command Line:** Anything you specify on the command line wil override the settings in your config files. For a full list of command line options, see Jekyll - Configuration Options [Serve Commands](https://jekyllrb.com/docs/configuration/options/#serve-command-options) and [Build Commands](https://jekyllrb.com/docs/configuration/options/#build-command-options)
57
+
**Command Line:** Anything you specify on the command line will override the settings in your config files. For a full list of command line options, see Jekyll - Configuration Options [Serve Commands](https://jekyllrb.com/docs/configuration/options/#serve-command-options) and [Build Commands](https://jekyllrb.com/docs/configuration/options/#build-command-options)
Copy file name to clipboardExpand all lines: content/features.md
+20-7Lines changed: 20 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -7,20 +7,30 @@ columns: 10
7
7
8
8
## Benefits of Workflows and Standards
9
9
10
-
### Why Use Workfows?
10
+
### Why Use Workflows?
11
11
12
12
Workflows and using workflow tools help make your computation methods portable, maintainable, reproducible and shareable. Often analysis methods contain many steps, perhaps in multiple languages and workflows help researchers document, run and maintain these complicated analyses.
13
13
Using a workflow system rather than a series of scripts has a number of benefits including abstraction, scaling, automation, and provenance (ASAP).
14
14
Workflows enable a clear abstraction about the components of your analysis, the relationship between the components and the inputs and outputs for each component allows for a well-labeled analysis with documented expectation. This abstraction helps enable the other benefits of scaling, automation and provenance.
15
15
Workflow execution can be parallelized or distributed making use of cluster, cloud, and high performance computing (HPC) environments. This helps to solve larger problems and analyze larger datasets faster.
16
16
17
-
Automation helps when running repetitive pipelines for example when running parameter sweeps or the same analysis on different sets of data. Workflow engines can use the inherient abstraction of workflows to efficently track, plan and manage the executation of workflow components.
18
-
Lastly, provenance tracking helps with auditing, tranparency, and validation. Ultimately, using workflows in the long run helps save time and effort and allows for easier scaling, tracking, sharing and reuse.
17
+
Automation helps when running repetitive pipelines, for example when running
18
+
parameter sweeps or the same analysis on different sets of data. Workflow engines
19
+
can use the inherient abstraction of workflows to efficiently track, plan and
20
+
manage the execution of workflow components.
21
+
Lastly, provenance tracking helps with auditing, tranparency, and validation.
22
+
Ultimately, using workflows in the long run helps save time and effort and
23
+
allows for easier scaling, tracking, sharing and reuse.
19
24
20
25
### Why Use a Standard?
21
26
22
-
A standard for sharing and reusing workflows can provide a solution to describing portable,re-usable workflows while also being workflow-engine and vendor-neutral.
23
-
Although workflows are [very popular](https://s.apache.org/existing-workflow-systems), prior to the CWL standards every workflow system was incompatible with every other. This means, those users not using the CWL standards are required to express their computational workflows in a different way everytime they have to use another workflow system. This greatly hampers reuse and collaboration.
27
+
A standard for sharing and reusing workflows can provide a solution to describing
28
+
portable,re-usable workflows while also being workflow-engine and vendor-neutral.
29
+
Although workflows are [very popular](https://s.apache.org/existing-workflow-systems),
30
+
prior to the CWL standards every workflow system was incompatible with every other.
31
+
This means, those users not using the CWL standards are required to express their
32
+
computational workflows in a different way every time they have to use another
33
+
workflow system. This greatly hampers reuse and collaboration.
24
34
25
35
### When to Use CWL?
26
36
@@ -29,7 +39,7 @@ command-line tool based data analysis.
29
39
CWL is for dataflow style batch analysis consisting of command line programs. It is not designed for supporting safe interaction with stateful (web) services, real-time communication between workflow steps, or workflows that need particular steps run at or during a
30
40
specific day/time-frame.
31
41
32
-
## Reusability and Reproduciblity with CWL
42
+
## Reusability and Reproducibility with CWL
33
43
CWL workflows are portable, reusable, and flexible. Reproduction, reuse, and replication of computational methods requires a complete description of what computer applications were used, how exactly they were used, and how they were connected to each other. To this end, CWL enables portability by being explicit about inputs/outputs to form the data flow, data locations and execution models. CWL supports using software container technologies, such as Docker and Singularity, to enable portability. For increased flexiblity, individual CWL tool definitions can be reused in any new workflow.
34
44
35
45
<figure>
@@ -42,7 +52,10 @@ Benefits of CWL including flexibility, portability, and scalability. CWL is well
42
52
43
53
## Parallelization and Scale with CWL
44
54
45
-
CWL workflows describe each step with explict inputs and outputs. Workflow steps in CWL are not necessarily run in the order they are listed, instead the order is determined by the dependencies between steps. Workflow steps which do not depend on one another may run in parallel.
55
+
CWL workflows describe each step with explicit inputs and outputs. Workflow steps
56
+
in CWL are not necessarily run in the order they are listed, instead the order
57
+
is determined by the dependencies between steps. Workflow steps which do not
58
+
depend on one another may run in parallel.
46
59
47
60
Additionally, the **[scatter](https://www.commonwl.org/user_guide/23-scatter-workflow/index.html)** feature in CWL allows the repeated execution of a CWL step in parallel (depending on the resources available) over a list of inputs. This can be done without requiring the modification of the underlying tool description.
Copy file name to clipboardExpand all lines: content/getting-started.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,10 @@
12
12
13
13
* Learn to write CWL using the [CWL user guide](/user_guide/) which provides a gentle introduction to creating CWL command line tool and workflow descriptions.
14
14
* Browse [CWL Implementations](/implementations/) to find a software package that's right for you.
15
-
* Follow [CWL Recommended Practices](http://www.commonwl.org/user_guide/rec-practices/) to make your CWL tools and workflows more efficent, reusable and transparent.
15
+
* Follow [CWL Recommended Practices](http://www.commonwl.org/user_guide/rec-practices/) to make your CWL tools and workflows more efficient, reusable and transparent.
16
16
* Read <ahref="https://github.com/pitagora-galaxy/cwl/wiki/CWL-Start-Guide-JP" lang="ja" hreflang="ja">CWLの日本語での解説ドキュメント</a> a 15 minute introduction to the CWL project in Japanese.
17
17
* Watch a series of [video lessons about CWL](https://stepik.org/lesson/35918/step/1?unit=15070) in Russian as part of the <ahref="https://stepik.org/course/1612/syllabus" lang="ru">Управление вычислениями</a> (Computation Management) free online course.
18
-
* Find [CWL descriptions for life-science tools](https://github.com/common-workflow-library/bio-cwl-tools) to use directly or incoporate into your workflows.
18
+
* Find [CWL descriptions for life-science tools](https://github.com/common-workflow-library/bio-cwl-tools) to use directly or incorporate into your workflows.
0 commit comments