From 941b2d0586955d7a4fceae8b395f640805483298 Mon Sep 17 00:00:00 2001 From: Volodymyr Date: Wed, 4 Sep 2024 18:57:42 +0200 Subject: [PATCH] Update guide-development.md --- content/docs/guide-development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/guide-development.md b/content/docs/guide-development.md index f27fbfb..c83919a 100644 --- a/content/docs/guide-development.md +++ b/content/docs/guide-development.md @@ -11,7 +11,7 @@ Workflows are all things that can be computed, broadly speaking. For reproducibi ## Build a repeatable parameterized workflow -Suppose you have a [**jupyter notebook**](https://renkulab.io/projects/astronomy/mmoda/fermi/files/blob/Lightcurve.ipynb) that derives some useful information (a lightcurve in the GeV gamma-ray band) on an astronomical source from data found in an astronomical data archive (in our example, it will be [Fermi LAT data archive](https://fermi.gsfc.nasa.gov/ssc/data/access/)). +Suppose you have a [**jupyter notebook**](https://renkulab.io/projects/astronomy/mmoda/fermi/files/blob/Lightcurve.ipynb) that derives some useful information (a lightcurve in the GeV gamma-ray band) on an astronomical source from data found in an astronomical data archive (in our example, it will be [Fermi LAT data archive](https://fermi.gsfc.nasa.gov/ssc/data/access/)). The first essential step in promoting the notebook to an ORDAS is to make the workflow of the notebook **reusable** by parameterizing it. For example, it is initeresting to enable generation of similar data products for different sources, by simply giving the source name or coordinates as **input parameters** to the workflow. It is also useful to explicitly tag the resulting data product (the lightcurve in our example) as the **output**, to make clear which of the numerous entities generated by the notebook is the final result. It is also possible to convert non-parametrized but strickly repeatable notebooks to services (for example, to assure reproducibility of a result published in a research publication), but this is less interesting since they always produce the same output data products. @@ -364,7 +364,7 @@ To add a help for the workflow one have to create a file `mmoda_help_page.md` in ![Help button screenshot](fermi-help-button.png) ![Help page screenshot](fermi-help-page.png) -The file `aknowledgemets.md` is used to edit the acknowledgements text, which is shown at the bottom of the products window. The default text refers to the renku repository, in which the workflow was created. +The file `acknowledgements.md` is used to edit the acknowledgements text, which is shown at the bottom of the products window. The default text refers to the renku repository, in which the workflow was created.