Support and document different installation and usage modes

[agstephens]

We are dependent on the IOOS compliance checker. It has a number of its own dependencies. We need a standard python environment to install it into.

Tasks:

1. Start at current version: 4.3.3
2. Try: Python3.8 (we might have to go back to Python3.7 if there are problems).
3. Let's go for installing with Conda following recipes below.

Installation recipes:

• https://github.com/ioos/compliance-checker/#installation
• https://github.com/ioos/compliance-checker/wiki/Installation#using-conda
• http://ioos.github.io/notebooks_demos/other_resources/

[gapintheclouds]

@agstephens Installed compliance-checker using conda. It doesn't accept --yaml options. Trying to work out why by looking at other plugins.

[agstephens]

Good work @gapintheclouds , It might be worth looking back to a version of the compliance-checker that the yaml plugin did work with. That might give clues.

[agstephens]

We just need a very well documented installation recipe before we close this. We need to take different usage modes into account:

ROLE 1: Core developer

• read AMF vocabs and product descriptions
• push AMF vocabs and product descriptions to GitHub
• publish releases of AMF vocabs and product descriptions (on GitHub)
• generate YAML checks (for AMF)
• publish YAML checks on GitHub
• maintain and develop amf-check-writer code (e.g. add new functionality, fix bugs)
• +ROLE 2
• +ROLE 3
• +ROLE 4

ROLE 2: Check developer

• add new checks to compliance-check-lib

ROLE 3: Project coordinator

• define a set of checks
• publish/release YAML check set (for project)
• +ROLE 4

ROLE 4: CV developer

• define a controlled vocabularies (CVs)
• convert CVs to pyessv format
• publish/release CVs

ROLE 5: Deployer

• install checking framework for specific project(s)

ROLE 6: Scientific end-user

• run the checker on data files

[agstephens]

@gapintheclouds : come up with a draft plan for how we document/manage/script/communicate this complexity.