From 8663cd40433d3c4e43b67987d65ae77e57a1864f Mon Sep 17 00:00:00 2001 From: Peter Ebert Date: Fri, 30 Dec 2016 10:31:29 +0100 Subject: [PATCH] MAINT: improved readability --- validation/README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/validation/README.md b/validation/README.md index 08e0df5..e36d470 100644 --- a/validation/README.md +++ b/validation/README.md @@ -2,13 +2,17 @@ ## Purpose -After you generated a new *Process* file, it is desirable to check that the document adheres to the DEEP *Process* specification that is defined in the XML schema file `template/deep_process_schema.xsd`. +After you generated a new *Process* file, it is desirable to check that the document +adheres to the DEEP *Process* specification that is defined in the XML schema file `template/deep_process_schema.xsd`. To achieve that with little to no extra effort, you can run the small Python validation script `mdvalid.py`. ## Installation -The script requires no setup and works with Python2.7+ or Python3.2+. It uses the mature *lxml* library that is not part of the Python standard library. -Please install [lxml](http://lxml.de/installation.html) according to your software environment. For your convenience, we provide two YAML files to install a complete -environment for Python2 or Python3 (whichever you prefer) using the [Conda](http://conda.pydata.org/miniconda.html) package manager. +The script itself requires no installation or configuration and works with Python2.7+ or Python3.2+. +It uses the *lxml* package that is not part of the Python standard library. +Please install [lxml](http://lxml.de/installation.html) according to your software environment. +For your convenience, we provide two YAML files to install a complete +environment for Python2 or Python3 (whichever you prefer) +using the [Conda](http://conda.pydata.org/miniconda.html) package manager. --- @@ -16,8 +20,9 @@ environment for Python2 or Python3 (whichever you prefer) using the [Conda](http Note from: 2016-12-29 -Due to some dependency issues of *lxml*, it has to be installed from within the activated Conda environment. -That is why, in the Conda YAML files, the line `- lxml=3.*` is commented out - see also here: [Github issues](https://github.com/conda/conda/issues/4093) +Due to some dependency issues concerning the *lxml* package and Conda, *lxml* currently it has to be installed +from within the activated Conda environment. That is why, in the Conda YAML files, +the line `- lxml=3.*` is commented out - see also here: [Github issue 4093](https://github.com/conda/conda/issues/4093) ---