WIP: schemas

.travis.yml

@@ -20,11 +20,14 @@ install:
   - conda update conda
 
   # Install dependencies
-  - conda install python
+  - conda create -n test --file requirements/run.txt
+  - source activate test
   - python setup.py install
 
 script:
   - set -e
+  - conda install --file requirements/test.txt
+  - pytest -vvs .
   - # Command to build your docs
   - pip install doctr
   - conda install --file requirements/doc.txt

docs/collections/abstracts.rst

@@ -1,82 +1,56 @@
 Abstracts
-============
+=========
 Abstracts for a conference or workshop. This is generally public information
 
 Schema
 ------
 The following lists key names mapped to its type and meaning for each entry.
 
-:_id: str, Unique identifier for submission. This generally includes the author name and
-    part of the title.
-:title: str, title of the presentation/paper.
-:firstname: str, first name of the author.
-:lastname: str, last name of the author.
-:coauthors: str, names of coauthors, optional
-:email: str, contact email for the author.
-:institution: str, name of the inistitution
-:references: str, HTML string of reference for the abstract itself, optional
-:text: str, HTML string of the abstract.
-:timestamp: The time when the abstract was submitted.
+:_id: string, Unique identifier for submission. This generally includes the author name and part of the title., required
+:coauthors: string, names of coauthors, optional
+:email: string, contact email for the author., required
+:firstname: string, first name of the author., required
+:institution: string, name of the inistitution, required
+:lastname: string, last name of the author., required
+:references: string, HTML string of reference for the abstract itself, optional
+:text: string, HTML string of the abstract., required
+:timestamp: string, The time when the abstract was submitted., required
+:title: string, title of the presentation/paper., required
 
 
 YAML Example
 ------------
 
 .. code-block:: yaml
 
-    Mouginot.Model:
-      title: Model Performance Analysis
-      firstname: Baptiste
-      lastname: Mouginot
-      coauthors: P.P.H. Wilson
-      email: [email protected]
-      institution: University of Wisconsin-Madison
-      references: "[1] B. MOUGINOT, “CyCLASS: CLASS models for Cyclus,”, Figshare, https://dx.doi.org/10.6084/m9.figshare.3468671.v2\
-        \ (2016).\n[2] B. Mouginot, P.P.H. Wilson, R.W. Carlsen, “Impact of Isotope Fidelity\
-        \ on Fuel Cycle Calculations”, ANS Winter Conference, Las Vegas, (November 2016)\n\
-        [3] B. Leniau, B. Mouginot, N. Thiollière, X. Doligez, A. Bidaud, F. Courtin,\
-        \ M. Ernoult and S. David, “A neural network approach for burn-up calculation\
-        \ and its application to the dynamic fuel cycle code CLASS,” Annals of Nuclear\
-        \ Energy , 81 , 125 – 133 (2015).\n[4] B. Leniau, F. Courtin, B. Mouginot, N.\
-        \ Thiollière, X. Doligez, A. Bidaud, “Generation of SFR Physics Models for the\
-        \ Nuclear Fuel Cycle Code CLASS” PHYSOR 2016\n"
-      text: "The CLASS team has developed high quality predictors based on pre-trained\
-        \ neural networks, allowing the estimation the evolution different neutronic parameters,\
-        \ such as neutron multiplication factor or macroscopic cross sections, along the\
-        \ irradiation of the fuel. This allows building various fuel fabrication and depletion\
-        \ models for fuel cycle simulators. The cyCLASS package [1]  has been developed\
-        \ to allow the use of CLASS  fabrication and cross section prediction models inside\
-        \ Cyclus. cyCLASS provides a reactor facility and a fuel fabrication facility,\
-        \ which are able to use any CLASS models to provide/request fuel to the entire\
-        \ Cyclus ecosystem. Using cyCLASS, it has been possible to perform fuel cycle\
-        \ simulations comparing different levels of archetypes fidelity[2].\n\nThis work\
-        \ focuses on the analysis of the performance of some high fidelity models developed\
-        \ from [3,4], extending the isotopic validity space from uranium and plutonium\
-        \ to the most common transuranic elements for Light Water Reactors (LWR) and Sodium\
-        \ Fast Reactors (SFR). Those extended models were required to study a transition\
-        \ scenario from the actual US nuclear fleet to a SFR and LWR fleet reprocessing\
-        \ the most commun transuranic elements (see “Recipe vs Model” presentation from\
-        \ the same author). The present work aims to evaluate the following for each of\
-        \ the models:\nthe performance relative to the training sample density,\nthe precision\
-        \ topography inside and outside of the validity space,\nthe performance of the\
-        \ burnup calculation for the cross section predictors.\nAs a complete set of real\
-        \ data is not available to benchmark such models, their relative performances\
-        \ will be evaluated with regards to the depletion tool used to train them.\n"
-      timestamp: 5/5/2017 13:15:59
+	Mouginot.Model:
+	  institution: University of Wisconsin-Madison
+	  firstname: Baptiste
+	  email: [email protected]
+	  title: Model Performance Analysis
+	  references: '[1] B. MOUGINOT, “cyCLASS: CLASS models for Cyclus,”, Figshare, https://dx.doi.org/10.6084/m9.figshare.3468671.v2
+	    (2016).'
+	  coauthors: P.P.H. Wilson
+	  timestamp: 5/5/2017 13:15:59
+	  text: The CLASS team has developed high quality predictors based on pre-trained
+	    neural network...
+	  lastname: Mouginot
 
 
 JSON/Mongo Example
 ------------------
 
 .. code-block:: json
 
-    {"_id": "Mouginot.Model",
-     "coauthors": "P.P.H. Wilson",
-     "email": "[email protected]",
-     "firstname": "Baptiste",
-     "institution": "University of Wisconsin-Madison",
-     "lastname": "Mouginot",
-     "references": "[1] B. MOUGINOT, \u201ccyCLASS: CLASS models for Cyclus,\u201d, Figshare, https://dx.doi.org/10.6084/m9.figshare.3468671.v2 (2016).",
-     "text": "The CLASS team has developed high quality predictors based on pre-trained neural network...",
-     "timestamp": "5/5/2017 13:15:59",
-     "title": "Model Performance Analysis"}
+	{
+	    "_id": "Mouginot.Model",
+	    "coauthors": "P.P.H. Wilson",
+	    "email": "[email protected]",
+	    "firstname": "Baptiste",
+	    "institution": "University of Wisconsin-Madison",
+	    "lastname": "Mouginot",
+	    "references": "[1] B. MOUGINOT, \u201ccyCLASS: CLASS models for Cyclus,\u201d, Figshare, https://dx.doi.org/10.6084/m9.figshare.3468671.v2 (2016).",
+	    "text": "The CLASS team has developed high quality predictors based on pre-trained neural network...",
+	    "timestamp": "5/5/2017 13:15:59",
+	    "title": "Model Performance Analysis"
+	}

docs/collections/assignments.rst

@@ -1,50 +1,60 @@
 Assignments
-============
+===========
 Information about assignments for classes.
 
 Schema
 ------
 The following lists key names mapped to its type and meaning for each entry.
 
-:_id: str, A unique id for the assignment, such a HW01-EMCH-558-2016-S
-:courses: list of str,  ids of the courses that have this assignment
-:category: str, such as 'homework' or 'final'
-:file: str, path to assignment file in store, optional
-:solution: str, path to solution file in store, optional
-:question: list of str,  titles for the questions on this assignment,
-    optional, defaults to 1-indexed ints if absent.
-:points: list of int or float, list of number of points possible for each
-    question. Length is the number of questions
+:_id: string, A unique id for the assignment, such a HW01-EMCH-558-2016-S, required
+:category: string, such as 'homework' or 'final', required
+:courses: string, ids of the courses that have this assignment, required
+:file: string, path to assignment file in store, optional
+:points: ('integer', 'float'), list of number of points possible for each question. Length is the number of questions, required
+:question: string, titles for the questions on this assignment, optional
+:solution: string, path to solution file in store, optional
 
 
 YAML Example
 ------------
 
 .. code-block:: yaml
 
-    hw01-rx-power:
-      category: homework
-      courses:
-        - EMCH-558-2016-S
-        - EMCH-758-2016-S
-      points:
-        - 1
-        - 2
-        - 3
-      questions:
-        - 1-9
-        - 1-10
-        - 1-12
-
+	hw01-rx-power:
+	  courses:
+	    - EMCH-558-2016-S
+	    - EMCH-758-2016-S
+	  category: homework
+	  points:
+	    - 1
+	    - 2
+	    - 3
+	  questions:
+	    - 1-9
+	    - 1-10
+	    - 1-12
 
 
 JSON/Mongo Example
 ------------------
 
 .. code-block:: json
 
-    {"_id": "hw01-rx-power",
-     "category": "homework",
-     "courses": ["EMCH-558-2016-S", "EMCH-758-2016-S"],
-     "points": [1, 2, 3],
-     "questions": ["1-9", "1-10", "1-12"]}
+	{
+	    "_id": "hw01-rx-power",
+	    "category": "homework",
+	    "courses": [
+	        "EMCH-558-2016-S",
+	        "EMCH-758-2016-S"
+	    ],
+	    "points": [
+	        1,
+	        2,
+	        3
+	    ],
+	    "questions": [
+	        "1-9",
+	        "1-10",
+	        "1-12"
+	    ]
+	}

docs/collections/blog.rst

@@ -1,47 +1,48 @@
 Blog
-============
+====
 This collection represents blog posts written by the members of the research group.
 
 Schema
 ------
 The following lists key names mapped to its type and meaning for each entry.
 
-:_id: str, short represntation, such as this-is-my-title
-:title: str,  full human readable title
-:original: str, URL of original post, if this is a repost, optional
-:author: str, name or AKA of author
-:year: int, Publication year
-:month: str, Publication month
-:day: int, Publication day
-:post: str, actual contents of the post
+:_id: string, short represntation, such as this-is-my-title, required
+:author: string, name or AKA of author, required
+:day: integer, Publication day, required
+:month: string, Publication month, required
+:original: string, URL of original post, if this is a repost, optional
+:post: string, actual contents of the post, required
+:title: string, full human readable title, required
+:year: integer, Publication year, required
 
 
 YAML Example
 ------------
 
 .. code-block:: yaml
 
-    my-vision:
-        title: My Vision
-        author: Anthony Scopatz
-        year: 2015
-        month: September
-        day: 18
-        original: https://scopatz.com/my-vision/
-        post: |
-            I would like see things move forward. Deep, I know!
+	my-vision:
+	  year: 2015
+	  title: My Vision
+	  day: 18
+	  post: I would like see things move forward. Deep, I know!
+	  author: Anthony Scopatz
+	  original: https://scopatz.com/my-vision/
+	  month: September
 
 
 JSON/Mongo Example
 ------------------
 
 .. code-block:: json
 
-    {"_id": "my-vision",
-     "title": "My Vision",
-     "author": "Anthony Scopatz",
-     "year": 2015,
-     "month": "September",
-     "day": 18,
-     "original": "https://scopatz.com/my-vision/",
-     "post": "I would like see things move forward. Deep, I know!"}
+	{
+	    "_id": "my-vision",
+	    "author": "Anthony Scopatz",
+	    "day": 18,
+	    "month": "September",
+	    "original": "https://scopatz.com/my-vision/",
+	    "post": "I would like see things move forward. Deep, I know!",
+	    "title": "My Vision",
+	    "year": 2015
+	}

docs/collections/grades.rst

@@ -1,39 +1,47 @@
 Grades
-============
+======
 The grade for a student on an assignment. This information should be private.
 
 Schema
 ------
 The following lists key names mapped to its type and meaning for each entry.
 
-:_id: str, unique id, typically the student-assignment-course
-:student: str,  student id
-:assignment: str,  assignment id
-:course: str, course id
-:scores: list of int or float,  the number of points earned on each question
-:filename: str,  path to file in store, optional
+:_id: string, unique id, typically the student-assignment-course, required
+:assignment: string, assignment id, required
+:course: string, course id, required
+:filename: string, path to file in store, optional
+:scores: ('integer', 'float'), the number of points earned on each question, required
+:student: string, student id, required
 
 
 YAML Example
 ------------
 
 .. code-block:: yaml
 
-    Human A. Person-rx-power-hw02-EMCH-758-2017-S:
-      assignment: 2017-rx-power-hw02
-      course: EMCH-758-2017-S
-      scores:
-        - 1
-        - 1.6
-        - 3
+	Human A. Person-rx-power-hw02-EMCH-758-2017-S:
+	  student: hap
+	  course: EMCH-758-2017-S
+	  scores:
+	    - 1
+	    - 1.6
+	    - 3
+	  assignment: 2017-rx-power-hw02
 
 
 JSON/Mongo Example
 ------------------
 
 .. code-block:: json
 
-    {"_id": "Human A. Person-rx-power-hw02-EMCH-758-2017-S",
-     "assignment": "2017-rx-power-hw02",
-     "course": "EMCH-758-2017-S",
-     "scores": [1, 1.6, 3]}
+	{
+	    "_id": "Human A. Person-rx-power-hw02-EMCH-758-2017-S",
+	    "assignment": "2017-rx-power-hw02",
+	    "course": "EMCH-758-2017-S",
+	    "scores": [
+	        1,
+	        1.6,
+	        3
+	    ],
+	    "student": "hap"
+	}