@@ -63,20 +63,21 @@ less tasks. This is a useful flag to use when there is trust that all
6363possible patterns present in this application can be already found in the
6464smaller instances.
6565
66- Workflow recipes are automatically installed and can be used throughout the system. WfCommons creates a Python package in the directory
67- specified by the flag :code: `--out ` in which the :file: `setup.py ` and :file: `recipe.py ` files are stored. If the flag :code: `--no-install ` is set
68- when creating a package for a specific application, the user will need to install the package before using it. The code
69- bellow is an example of how to install/uninstall a package for an application in WfCommons: ::
66+ Workflow recipes are automatically installed and can be used throughout the
67+ system. WfCommons creates a Python package in the directory specified by the
68+ flag :code: `--out ` in which the :file: `setup.py ` and :file: `recipe.py ` files
69+ are stored. If the flag :code: `--no-install ` is set when creating a package
70+ for a specific application, the user will need to manually install the package
71+ before using it. The code bellow is an example of how to install/uninstall a
72+ package for an application in WfCommons: ::
7073
7174 # installing the package
72- $ pip install path/to/the/package
75+ $ pip install / path/to/the/package
7376
7477 # uninstalling a package
7578 $ pip uninstall wfcommons.wfchef.recipes.appication_name_workflow
7679
77-
78-
79- The snippet below show an example of how to import the recipes: ::
80+ The snippet below shows an example of how to import the recipes: ::
8081
8182 # creating an Epigenomics workflow recipe
8283 from wfcommons.wfchef.recipes import EpigenomicsRecipe
@@ -85,35 +86,3 @@ The snippet below show an example of how to import the recipes: ::
8586To check which recipes are installed in a system and how to import them use: ::
8687
8788 $ wfchef ls
88-
89-
90-
91-
92-
93- Examples
94- --------
95-
96- The following example generates 10 *Epigenomics * synthetic workflow instances
97- based on the number of tasks entered by the user (1000), builds the synthetic workflow instances, and writes the
98- synthetic instances to JSON files. ::
99-
100- from wfcommons.wfchef.recipes import EpigenomicsRecipe
101- from wfcommons.generator import WorkflowGenerator
102-
103- generator = WorkflowGenerator(EpigenomicsRecipe.from_num_tasks(1000))
104- for i, workflow in enumerate(generator.build_workflows(10)):
105- workflow.write_json(f'epigenomics-workflow-{i}.json')
106-
107- The example below generates a *Cycles * (agroecosystem) synthetic workflow instance based on the number
108- of tasks entered by the user (250), builds the synthetic workflow instance, and writes the synthetic
109- instance to a JSON file. ::
110-
111- from wfcommons.wfchef.recipes import CyclesRecipe
112- from wfcommons.generator import WorkflowGenerator
113-
114- generator = WorkflowGenerator(CyclesRecipe.from_num_tasks(250))
115- workflow = generator.build_workflow()
116- workflow.write_json(f'cycles-workflow.json')
117-
118- ..
119- maybe we should pout examples only on generator, because we need it
0 commit comments