More examples

README.md

@@ -18,18 +18,53 @@ Dependencies:
 	`pip install weasyprint==0.42.3`
 * Unfortunately there is also a dependency on system gtk librararies, which may or may not be a problem for some. How I got it to work with MacOS is [documented in the code](https://github.com/bnlawrence/esdoc4scientists/blob/ad64f25f111ff7f7a3b6d1de3d96ebe6a89eaeb0/experiment.py#L12).
 
-All the code in this version is in one script, and you can see several instances of how to use it in the test cases, which cover
+All the code in this version is in one script, and you can see several instances of how to use it in the test cases, which can be run by simply typing `python experiment.py`, and cover:
 
 1. For _Experiment_  or _MIP_ documents, outputting a one or two column table, and
 2. Creating a table which describes CMIP6.
 
 An example<sup>[1](#fn1)</sup> of the first is: ![expected_output/doubleExperiment.pdf](expected_output/double_cropped.jpg)
 
+An example of using these classes in a real live application (producing tables for a paper) is the following:
+```python
+import os
+
+from experiment import Repo, Experiment, Mip, CMIP6
+
+os.environ['ESDOC_API'] = 'https://api.es-doc.org'
+
+experiments = ['abrupt-4xCO2','land-NoFire', 'g6sulfur', 'g7sst1-cirrus']
+widths = [True, False, True, False]
+
+mips = ['CMIP','DECK','GeoMIP','CMIP6']
+
+r = Repo()
+
+docs = [r.getbyname(e) for e in experiments]
+mdocs = [r.getbyname(m,'mip') for m in mips ]
+
+for e,d,w in zip(experiments, docs, widths):
+    E = Experiment(d)
+    E.render('%s.pdf' % e, wide=w)
+
+for m,d in zip(mips,mdocs):
+    M = Mip(d)
+    M.render('%s.pdf' % m, wide=True)
+
+
+C = CMIP6()
+C.render('cmip6.pdf')
+print C.reference_list
+print C.nocite
+
+```
+
 #### Changing the Layout and Developing New Capability
 
 Users who want to change the layout of the tables, or develop new tables may need to try and understand  _pyesdoc_ which does the heavy lifting via Python class instances for manipulating ESDOC documents. 
 
 * If you want to change the layout only, then you can play with the jinja2 templates alone, you won't need to understand _pyesdoc_.
+* It would be relatively straight forward to create new templates for latex table output. I didn't do that in this version since they were pretty ugly, for this purpose (at least without using some of the more fancy table packages). I expect for future model comparison tables, someone (me maybe) will make latex table output.
 * The documentation for _pyesdoc_ itself is rather sparse right now, but you can't go too far wrong by just playing at the console and using introspection. 
 * You can also inspect the attributes and structure by looking at the [canonical schema description](https://github.com/ES-DOC/esdoc-cim-v2-schema). For example [this code](https://github.com/ES-DOC/esdoc-cim-v2-schema/blob/bdf6e8268da0e0ba7f7bc3252644042fc79c3434/designing_classes.py#L173) is the definition of an _Experiment_ and you can see the attributes which an Experiment instance must have.
 * A key concept you will need to deal with is that the documents are all linked together. As you navigate around them pythonically you will get the title and uid and types of other documents in links (e.g. the Experiment references _Requirements_), and sometimes you will need to pull the full description of those via the UID. Code to do this is included. Note how the additional requirements [are found](https://github.com/bnlawrence/esdoc4scientists/blob/ad64f25f111ff7f7a3b6d1de3d96ebe6a89eaeb0/experiment.py#L226) for the example above.