Skip to content

Commit

Permalink
add documentation for collection files
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenhua0320 committed Jul 18, 2024
1 parent d647ca1 commit a168e61
Show file tree
Hide file tree
Showing 16 changed files with 2,267 additions and 0 deletions.
56 changes: 56 additions & 0 deletions doc/source/collections/abstracts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +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: 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:
coauthors: P.P.H. Wilson
email: mouginot@wisc.edu
firstname: Baptiste
institution: University of Wisconsin-Madison
lastname: Mouginot
references: '[1] B. MOUGINOT, “cyCLASS: CLASS models for Cyclus,”, 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
JSON/Mongo Example
------------------

.. code-block:: json
{
"_id": "Mouginot.Model",
"coauthors": "P.P.H. Wilson",
"email": "mouginot@wisc.edu",
"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"
}
62 changes: 62 additions & 0 deletions doc/source/collections/assignments.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Assignments
===========
Information about assignments for classes.

Schema
------
The following lists key names mapped to its type and meaning for each entry.

:_id: string, A unique id for the assignment, such as HW01-EMCH-558-2016-S, required
:category: string, such as 'homework' or 'final', required
:courses: ['string', 'list'], ids of the courses that have this assignment, required
:file: string, path to assignment file in store, optional
:points: list, list of number of points possible for each question. Length is the number of questions, required

:anyof_type: ['integer', 'float'], optional
:questions: list, 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
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"
]
}
48 changes: 48 additions & 0 deletions doc/source/collections/blog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +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: string, short representation, such as this-is-my-title, required
:author: string, name or AKA of author, required
:day: integer, Publication day, required
:month: ['string', 'integer'], 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:
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
JSON/Mongo Example
------------------

.. code-block:: json
{
"_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
}
50 changes: 50 additions & 0 deletions doc/source/collections/contacts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Contacts
========
a lighter version of people. Fewer required fieldsfor capturing people who are less tightly coupled

Schema
------
The following lists key names mapped to its type and meaning for each entry.

:aka: list, other names for the person, optional
:department: string, Department at the institution, optional
:email: string, Contact email for the contact, optional
:institution: string, the institution where they are located. This isrequired for building a COI list of coauthors, butnot in general. It can be institute id or anythingin the aka or name, optional
:name: string, the person canonical name, required
:notes: ['list', 'string'], notes about the person, optional
:title: string, how the person is addressed, optional


YAML Example
------------

.. code-block:: yaml
afriend:
aka:
- A. B. FriendAB FriendTony Friend
department: physics
email: friend@deed.com
institution: columbiau
name: Anthony B Friend
notes: The guy I meet for coffee sometimes
title: Mr.
JSON/Mongo Example
------------------

.. code-block:: json
{
"_id": "afriend",
"aka": [
"A. B. FriendAB FriendTony Friend"
],
"department": "physics",
"email": "friend@deed.com",
"institution": "columbiau",
"name": "Anthony B Friend",
"notes": "The guy I meet for coffee sometimes",
"title": "Mr."
}
Loading

0 comments on commit a168e61

Please sign in to comment.