From 924454966b0b8e51b69ba3ea6ef87a9dec8170ec Mon Sep 17 00:00:00 2001 From: Stefan Bienert <stefan.bienert@unibas.ch> Date: Wed, 16 Sep 2015 15:16:29 +0200 Subject: [PATCH] Documentation --- pipeline/doc/run_engine.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pipeline/doc/run_engine.rst b/pipeline/doc/run_engine.rst index 38756d83..753130aa 100644 --- a/pipeline/doc/run_engine.rst +++ b/pipeline/doc/run_engine.rst @@ -1,13 +1,13 @@ -:mod:`~promod3.pipeline.run_engine` - Build models from various starting points +:mod:`~promod3.pipeline.run_engine` - Build Models From Various Starting Points ================================================================================ .. currentmodule:: promod3.pipeline.run_engine Introduction -------------------------------------------------------------------------------- -- if you just want to build models, go here -- everything needed wrapped in single functions -- that way, if the default pipeline changes, no need to change your code +This is a collection of functions to just build models. All steps needed to go from various starting points to a complete model are wrapped in single function calls. That way, if something changes in the default pipeline, e.g. on general improvements, there is no need to change code depending on |project| to adapt. + + - also convenient for developing new stuff - e.g. you want to transform the template coordinates in some way, but then just want to see them in a model, go by BuildFromRawModel -- GitLab