Skip to content

Commit

Permalink
MAINT: improved readability
Browse files Browse the repository at this point in the history
  • Loading branch information
pebert committed Dec 30, 2016
1 parent 2ba3f72 commit 8663cd4
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions validation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,27 @@

## 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.

---

#### Attention

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)

---

Expand Down

0 comments on commit 8663cd4

Please sign in to comment.