diff --git a/doc/source/collections/abstracts.rst b/doc/source/collections/abstracts.rst new file mode 100644 index 000000000..1543414ca --- /dev/null +++ b/doc/source/collections/abstracts.rst @@ -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" + } diff --git a/doc/source/collections/assignments.rst b/doc/source/collections/assignments.rst new file mode 100644 index 000000000..e60e66649 --- /dev/null +++ b/doc/source/collections/assignments.rst @@ -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" + ] + } diff --git a/doc/source/collections/blog.rst b/doc/source/collections/blog.rst new file mode 100644 index 000000000..87388424c --- /dev/null +++ b/doc/source/collections/blog.rst @@ -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 + } diff --git a/doc/source/collections/contacts.rst b/doc/source/collections/contacts.rst new file mode 100644 index 000000000..8c399f25e --- /dev/null +++ b/doc/source/collections/contacts.rst @@ -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." + } diff --git a/doc/source/collections/expenses.rst b/doc/source/collections/expenses.rst new file mode 100644 index 000000000..6f1038f86 --- /dev/null +++ b/doc/source/collections/expenses.rst @@ -0,0 +1,212 @@ +Expenses +======== +This collection records expenses for the group. It should most likely be private + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, short representation, such as this-is-my-name, required + + Allowed values: + * travel + * business +:grant_percentages: list, the percentage of the reimbursement amount to put on each grant. This list must be the same length asthe grants list and the percentages placed in the order that the grants appear in that list, optional +:grants: ['string', 'list'], the grants in a list, or a string if only one grant, required +:itemized_expenses: list, optional + + :type: dict, optional + + :day: integer, Expense day, optional + :month: ['string', 'integer'], Expense month, optional + :year: integer, Expense year, optional + :purpose: string, reason for expense, optional + :unsegregated_expense: float, The allowed expenses, optional + :segregated_expense: float, The unallowed expenses, optional + :original_currency: float, The currency the payment was made in, optional +:overall_purpose: string, The reason for the expenses, required +:payee: string, The name or id of the payee filing the expense, required +:project: ['string', 'list'], project or list of projects that this presentation is associated with. Should be discoverable in projects collection, required + + +YAML Example +------------ + +.. code-block:: yaml + + test: + expense_type: business + grant_percentages: + - '50' + - '50' + grants: + - dmref15 + - SymPy-1.1 + itemized_expenses: + - day: 1 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 10 + year: 2018 + - day: 2 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 20 + year: 2018 + - day: 3 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 30 + year: 2018 + - day: 4 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 40 + year: 2018 + - day: 5 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 50 + year: 2018 + - day: 6 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 60 + year: 2018 + - day: 7 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 70 + year: 2018 + - day: 8 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 80 + year: 2018 + - day: 9 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 90 + year: 2018 + - day: 10 + month: Jan + purpose: test + segregated_expense: 0 + unsegregated_expense: 100 + year: 2018 + overall_purpose: testing the database + payee: scopatz + project: Cyclus + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "test", + "expense_type": "business", + "grant_percentages": [ + "50", + "50" + ], + "grants": [ + "dmref15", + "SymPy-1.1" + ], + "itemized_expenses": [ + { + "day": 1, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 10, + "year": 2018 + }, + { + "day": 2, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 20, + "year": 2018 + }, + { + "day": 3, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 30, + "year": 2018 + }, + { + "day": 4, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 40, + "year": 2018 + }, + { + "day": 5, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 50, + "year": 2018 + }, + { + "day": 6, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 60, + "year": 2018 + }, + { + "day": 7, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 70, + "year": 2018 + }, + { + "day": 8, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 80, + "year": 2018 + }, + { + "day": 9, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 90, + "year": 2018 + }, + { + "day": 10, + "month": "Jan", + "purpose": "test", + "segregated_expense": 0, + "unsegregated_expense": 100, + "year": 2018 + } + ], + "overall_purpose": "testing the database", + "payee": "scopatz", + "project": "Cyclus" + } diff --git a/doc/source/collections/grades.rst b/doc/source/collections/grades.rst new file mode 100644 index 000000000..0f56a68dc --- /dev/null +++ b/doc/source/collections/grades.rst @@ -0,0 +1,49 @@ +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: 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: list, the number of points earned on each question, required + + :anyof_type: ['integer', 'float'], optional +: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 + student: hap + + +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 + ], + "student": "hap" + } diff --git a/doc/source/collections/grants.rst b/doc/source/collections/grants.rst new file mode 100644 index 000000000..eb8cba8d5 --- /dev/null +++ b/doc/source/collections/grants.rst @@ -0,0 +1,180 @@ +Grants +====== +This collection represents grants that have been awarded to the group. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: ('string', 'integer', 'float'), short representation, such as this-is-my-name, required +:account: string, the account number which holds the funds, optional +:admin: string, the group administering the grant, optional +:amount: ('integer', 'float'), value of award, required +:begin_day: integer, start day of the grant, optional +:begin_month: ['string', 'integer'], start month of the grant, required +:begin_year: integer, start year of the grant, required +:benefit_of_collaboration: string, optional +:call_for_proposals: string, optional +:currency: string, typically '$' or 'USD', optional +:end_day: ('string', 'integer'), end day of the grant, optional +:end_month: ['string', 'integer'], end month of the grant, optional +:end_year: integer, end year of the grant, required +:funder: string, the agency funding the work, required +:grant_id: string, the identifier for this work, optional +:institution: string, the host institution for the grant, optional +:narrative: string, optional +:notes: string, notes about the grant, optional +:person_months_academic: ['integer', 'float'], Number of months of funding during the academicyear, optional +:person_months_summer: ['integer', 'float'], Number of months of funding during the summer, optional +:program: string, the program the work was funded under, required +:scope: string, The scope of the grant, answers the prompt: "Describe Research Including Synergies and Delineation with Respect to this Proposal/Award:", optional +:status: string, status of the grant, optional + + Allowed values: + * pending + * declined + * accepted + * in-prep +:team: list, information about the team members participating in the grant., required + + :type: dict, optional + + :cv: string, optional + :institution: string, optional + :name: string, optional + :position: string, optional + :subaward_amount: ('integer', 'float'), optional +:title: string, actual title of proposal / grant, required + + +YAML Example +------------ + +.. code-block:: yaml + + SymPy-1.1: + amount: 3000.0 + begin_day: 1 + begin_month: May + begin_year: 2030 + call_for_proposals: https://groups.google.com/d/msg/numfocus/wPjhdm8NJiA/S8JL1_NZDQAJ + end_day: 31 + end_month: December + end_year: 2030 + funder: NumFOCUS + narrative: https://docs.google.com/document/d/1nZxqoL-Ucni_aXLWmXtRDd3IWqW0mZBO65CEvDrsXZM/edit?usp=sharing + program: Small Development Grants + status: pending + team: + - institution: University of South Carolina + name: Anthony Scopatz + position: PI + - institution: University of South Carolina + name: Aaron Meurer + position: researcher + title: SymPy 1.1 Release Support + dmref15: + account: GG012345 + amount: 982785.0 + begin_day: 1 + begin_month: october + begin_year: 2015 + end_day: 30 + end_month: september + end_year: 2025 + funder: NSF + grant_id: DMREF-1534910 + institution: Columbia University + notes: Designing Materials to Revolutionize and Engineer our Future (DMREF) + person_months_academic: 0.0 + person_months_summer: 0.25 + program: DMREF + scope: This grant is to develop complex modeling methods for regularizing ill-posed + nanostructure inverse problems using data analytic and machine learning based + approaches. This does not overlap with any other grant. + team: + - institution: Columbia University + name: qdu + position: Co-PI + - institution: Columbia University + name: dhsu + position: Co-PI + - institution: Columbia University + name: Anthony Scopatz + position: PI + subaward_amount: 330000.0 + title: 'DMREF: Novel, data validated, nanostructure determination methods for accelerating + materials discovery' + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "SymPy-1.1", + "amount": 3000.0, + "begin_day": 1, + "begin_month": "May", + "begin_year": 2030, + "call_for_proposals": "https://groups.google.com/d/msg/numfocus/wPjhdm8NJiA/S8JL1_NZDQAJ", + "end_day": 31, + "end_month": "December", + "end_year": 2030, + "funder": "NumFOCUS", + "narrative": "https://docs.google.com/document/d/1nZxqoL-Ucni_aXLWmXtRDd3IWqW0mZBO65CEvDrsXZM/edit?usp=sharing", + "program": "Small Development Grants", + "status": "pending", + "team": [ + { + "institution": "University of South Carolina", + "name": "Anthony Scopatz", + "position": "PI" + }, + { + "institution": "University of South Carolina", + "name": "Aaron Meurer", + "position": "researcher" + } + ], + "title": "SymPy 1.1 Release Support" + } + { + "_id": "dmref15", + "account": "GG012345", + "amount": 982785.0, + "begin_day": 1, + "begin_month": "october", + "begin_year": 2015, + "end_day": 30, + "end_month": "september", + "end_year": 2025, + "funder": "NSF", + "grant_id": "DMREF-1534910", + "institution": "Columbia University", + "notes": "Designing Materials to Revolutionize and Engineer our Future (DMREF)", + "person_months_academic": 0.0, + "person_months_summer": 0.25, + "program": "DMREF", + "scope": "This grant is to develop complex modeling methods for regularizing ill-posed nanostructure inverse problems using data analytic and machine learning based approaches. This does not overlap with any other grant.", + "team": [ + { + "institution": "Columbia University", + "name": "qdu", + "position": "Co-PI" + }, + { + "institution": "Columbia University", + "name": "dhsu", + "position": "Co-PI" + }, + { + "institution": "Columbia University", + "name": "Anthony Scopatz", + "position": "PI", + "subaward_amount": 330000.0 + } + ], + "title": "DMREF: Novel, data validated, nanostructure determination methods for accelerating materials discovery" + } diff --git a/doc/source/collections/groups.rst b/doc/source/collections/groups.rst new file mode 100644 index 000000000..37dd42827 --- /dev/null +++ b/doc/source/collections/groups.rst @@ -0,0 +1,68 @@ +Groups +====== +Information about the research groupthis 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 +:aka: list, other names for the group, required +:banner: string, name of image file with the group banner, optional +:department: string, Name of host department, required +:email: string, Contact email for the group, required +:institution: string, Name of the host institution, required +:mission_statement: string, Mission statement of the group, optional +:name: string, Name of the group, required +:pi_name: string, The name of the Principle Investigator, required +:projects: string, About line for projects, required +:website: string, URL to group webpage, optional + + +YAML Example +------------ + +.. code-block:: yaml + + ergs: + aka: + - Energy Research Group Something + - Scopatz Group + department: Mechanical Engineering + email: scopatz (AT) cec.sc.edu + institution: University of South Carolina + mission_statement: "ERGS, or Energy Research Group: \n Scopatz,\ + \ is the Computational \n Nuclear\ + \ Engineering\n research group at the \n University of South Carolina. \n Our focus is on uncertainty quantification\ + \ & predictive modeling, nuclear \n fuel cycle simulation, and improving nuclear\ + \ engineering techniques through \n automation.\n We are committed to open\ + \ & accessible research tools and methods." + name: ERGS + pi_name: Anthony Scopatz + projects: "ERGS is involved in a large number of computational \n projects. Please\ + \ visit the projects page for \n more information!\n\ + \ " + website: www.ergs.sc.edu + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "ergs", + "aka": [ + "Energy Research Group Something", + "Scopatz Group" + ], + "department": "Mechanical Engineering", + "email": "scopatz (AT) cec.sc.edu", + "institution": "University of South Carolina", + "mission_statement": "ERGS, or Energy Research Group: \n Scopatz, is the Computational \n Nuclear Engineering\n research group at the \n University of South Carolina. \n Our focus is on uncertainty quantification & predictive modeling, nuclear \n fuel cycle simulation, and improving nuclear engineering techniques through \n automation.\n We are committed to open & accessible research tools and methods.", + "name": "ERGS", + "pi_name": "Anthony Scopatz", + "projects": "ERGS is involved in a large number of computational \n projects. Please visit the projects page for \n more information!\n ", + "website": "www.ergs.sc.edu" + } diff --git a/doc/source/collections/institutions.rst b/doc/source/collections/institutions.rst new file mode 100644 index 000000000..ee817a6b5 --- /dev/null +++ b/doc/source/collections/institutions.rst @@ -0,0 +1,109 @@ +Institutions +============ +This collection will contain all the institutionsin the world and their departments and addresses + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, unique identifier for the institution., required +:aka: list, list of all the different names this the institution is known by, optional +:city: string, the city where the institution is, required +:country: string, The country where the institution is, required +:departments: dict, all the departments and centers andvarious units in the institution, optional +:name: string, the canonical name of the institutions, required +:schools: dict, this is more for universities, but it be used for larger divisions in big organizations, optional +:state: string, the state where the institution is, optional +:street: string, the street where the institution is, optional +:zip: ['integer', 'string'], the zip or postal code of the institution, optional + + +YAML Example +------------ + +.. code-block:: yaml + + columbiau: + aka: + - Columbia University + - Columbia + city: New York + country: USA + departments: + apam: + aka: + - APAM + name: Department of Applied Physicsand Applied Mathematics + chemistry: + aka: + - Chemistry + - Dept. of Chemistry + name: Department of Chemistry + physics: + aka: + - Dept. of Physics + - Physics + name: Department of Physics + name: Columbia University + schools: + seas: + aka: + - SEAS + - Columbia Engineering + - Fu Foundation School of Engineering and Applied Science + name: School of Engineering and Applied Science + state: NY + street: 500 W 120th St + zip: '10027' + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "columbiau", + "aka": [ + "Columbia University", + "Columbia" + ], + "city": "New York", + "country": "USA", + "departments": { + "apam": { + "aka": [ + "APAM" + ], + "name": "Department of Applied Physicsand Applied Mathematics" + }, + "chemistry": { + "aka": [ + "Chemistry", + "Dept. of Chemistry" + ], + "name": "Department of Chemistry" + }, + "physics": { + "aka": [ + "Dept. of Physics", + "Physics" + ], + "name": "Department of Physics" + } + }, + "name": "Columbia University", + "schools": { + "seas": { + "aka": [ + "SEAS", + "Columbia Engineering", + "Fu Foundation School of Engineering and Applied Science" + ], + "name": "School of Engineering and Applied Science" + } + }, + "state": "NY", + "street": "500 W 120th St", + "zip": "10027" + } diff --git a/doc/source/collections/people.rst b/doc/source/collections/people.rst new file mode 100644 index 000000000..af2f882d8 --- /dev/null +++ b/doc/source/collections/people.rst @@ -0,0 +1,512 @@ +People +====== +This collection describes the members of the research group. This is normally public data. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, unique identifier for the group member, required +:active: boolean, If the person is an active member, default True., optional +:aka: ['string', 'list'], list of aliases (also-known-as), useful for identifying the group member in citations or elsewhere., required +:avatar: string, URL to avatar, required +:bio: string, short biographical text, required +:collab: boolean, If the person is a collaborator, default False., optional +:education: list, This contains the educational information for the group member., required + + :type: dict, optional + + :begin_day: integer, optional + :begin_month: ['string', 'integer'], optional + :begin_year: integer, optional + :degree: string, optional + :department: string, department withinthe institution, optional + :group: string, this employment is/was ina group in groups coll, optional + :end_day: integer, optional + :end_month: ['string', 'integer'], optional + :end_year: integer, optional + :gpa: ('float', 'string'), optional + :institution: string, optional + :location: string, optional + :other: list, optional +:email: string, email address of the group member, optional +:employment: list, Employment information, similar to educational information., optional + + :type: dict, optional + + :begin_day: integer, optional + :begin_month: ['string', 'integer'], optional + :begin_year: integer, optional + :department: string, optional + :end_day: integer, optional + :end_month: ['string', 'integer'], optional + :end_year: integer, optional + :group: string, this employment is/was ina group in groups coll, optional + :location: string, optional + :organization: string, optional + :other: list, optional + :position: string, optional + :status: string, optional +:funding: list, Funding and scholarship that the group member has individually obtained in the past. **WARNING:** this is not to be confused with the **grants** collection, optional + + :type: dict, optional + + :currency: string, optional + :duration: string, optional + :month: ['string', 'integer'], optional + :name: string, optional + :value: ('float', 'integer'), optional + :year: integer, optional +:google_scholar_url: string, URL of your Google Scholar rofile, optional +:home_address: dict, The person's home address, optional + + :street: string, street address, optional + :city: string, name of home city, optional + :state: string, name o home state, optional + :zip: string, zip code, optional +:honors: list, Honors that have been awarded to this group member, optional + + :type: dict, optional + + :description: string, optional + :month: ['string', 'integer'], optional + :name: string, optional + :year: integer, optional +:initials: string, The canonical initials for this group member, optional +:membership: list, Professional organizations this member is a part of, optional + + :type: dict, optional + + :begin_month: ['string', 'integer'], optional + :begin_year: integer, optional + :description: string, optional + :end_month: ['string', 'integer'], optional + :end_year: integer, optional + :organization: string, optional + :position: string, optional + :website: string, optional +:name: string, Full, canonical name for the person, required +:orcid_id: string, The ORCID ID of the person, optional +:position: string, such as professor, graduate student, or scientist, optional + + Allowed values: + * ``''`` + * undergraduate research assistant + * graduate research assistant + * research assistant + * post-doctoral scholar + * assistant scientist + * research scientist + * associate scientist + * research associate + * ajunct professor + * programer + * programmer + * visiting scientist + * research assistant professor + * assistant professor + * associate professor + * professor emeritus + * scientist + * engineer + * professor +:research_focus_areas: list, summary of research projects that are ongoing. Usedin Annual appraisal for example, optional + + :type: dict, optional + + :begin_year: integer, optional + :end_year: integer, optional + :description: string, optional +:service: list, Service that this group member has provided, optional + + :type: dict, optional + + :description: string, optional + :duration: string, optional + :month: ['string', 'integer'], Use month and year if the servicedoesn't extend more than one year.Otherwise use begin_year and end_year, optional + :name: string, optional + :year: integer, optional + :begin_year: integer, optional + :end_year: integer, optional + :other: ['string', 'list'], optional +:skills: list, Skill the group member has, optional + + :type: dict, optional + + :category: string, optional + :level: string, optional + :name: string, optional +:teaching: list, Courses that this group member has taught, if any, optional + + :type: dict, optional + + :course: string, optional + :description: string, optional + :end_month: ['string', 'integer'], optional + :end_year: integer, optional + :materials: string, optional + :month: ['string', 'integer'], optional + :organization: string, optional + :position: string, optional + :syllabus: string, optional + :video: string, optional + :website: string, optional + :year: integer, optional +:title: string, for example, Dr., etc., optional + + +YAML Example +------------ + +.. code-block:: yaml + + scopatz: + aka: + - Scopatz + - Scopatz, A + - Scopatz, A. + - Scopatz, A M + - Anthony Michael Scopatz + avatar: https://avatars1.githubusercontent.com/u/320553?v=3&s=200 + bio: Anthony Scopatz is currently an Assistant Professor + education: + - begin_year: 2008 + degree: Ph.D. Mechanical Engineering, Nuclear and Radiation Engineering Program + department: apam + end_year: 2011 + group: ergs + institution: The University of Texas at Austin + location: Austin, TX + other: + - 'Adviser: Erich A. Schneider' + - 'Dissertation: Essential Physics for Fuel Cycle Modeling & Analysis' + - begin_year: 2006 + degree: M.S.E. Mechanical Engineering, Nuclear and Radiation Engineering Program + end_year: 2007 + institution: The University of Texas at Austin + location: Austin, TX + other: + - 'Adviser: Erich A. Schneider' + - 'Thesis: Recyclable Uranium Options under the Global Nuclear Energy Partnership' + - begin_day: 1 + begin_month: Sep + begin_year: 2002 + degree: B.S. Physics + end_day: 20 + end_month: 5 + end_year: 2006 + institution: University of California, Santa Barbara + location: Santa Barbara, CA + other: + - Graduated with a Major in Physics and a Minor in Mathematics + - begin_year: 2008 + degree: ongoing + department: earth + group: life + institution: solar system + location: land, mostly + email: scopatz@cec.sc.edu + employment: + - begin_year: 2015 + group: ergs + location: Columbia, SC + organization: The University of South Carolina + other: + - 'Cyclus: An agent-based, discrete time nuclear fuel cycle simulator.' + - 'PyNE: The Nuclear Engineering Toolkit.' + - 'Website: http://www.ergs.sc.edu/' + position: Assistant Professor, Mechanical Engineering Department + - begin_day: 1 + begin_month: Jun + begin_year: 2013 + department: Physics + end_day: 15 + end_month: 3 + end_year: 2015 + location: Madison, WI + organization: CNERG, The University of Wisconsin-Madison + other: + - 'Cyclus: An agent-based, discrete time nuclear fuel cycle simulator.' + - 'PyNE: The Nuclear Engineering Toolkit.' + - 'Website: https://cnerg.github.io/' + position: Associate Scientist, Engineering Physics Department + - begin_day: 1 + begin_month: Nov + begin_year: 2011 + end_month: May + end_year: 2013 + location: Chicago, IL + organization: The FLASH Center, The University of Chicago + other: + - 'NIF: Simulation of magnetic field generation from neutral plasmas using + FLASH.' + - 'CosmoB: Simulation of magnetic field generation from neutral plasmas using + FLASH.' + - 'FLASH4: High-energy density physics capabilities and utilities.' + - 'Simulated Diagnostics: Schlieren, shadowgraphy, Langmuir probes, etc. from + FLASH.' + - 'OpacPlot: HDF5-based equation of state and opacity file format.' + - 'Website: http://flash.uchicago.edu/site/' + position: Research Scientist, Postdoctoral Scholar + status: PI + funding: + - name: Omega Laser User's Group Travel Award + value: 1100 + year: 2013 + - name: NIF User's Group Travel Award + value: 1150 + year: 2013 + google_scholar_url: https://scholar.google.com/citations?user=dRm8f + home_address: + city: The big apple + state: plasma + street: 123 Wallabe Ln + zip: '007' + initials: AMS + membership: + - begin_year: 2006 + organization: American Nuclear Society + position: Member + - begin_year: 2013 + organization: Python Software Foundation + position: Fellow + name: Anthony Scopatz + orcid_id: 0000-0002-9432-4248 + position: professor + research_focus_areas: + - begin_year: 2010 + description: software applied to nuclear engineering and life + service: + - name: 'Master of Ceremonies and Organizer Brown University "Chemistry: Believe + it or Not" public chemistry demonstration' + year: 2013 + - begin_year: 2012 + end_year: 2014 + name: Renewable Energy Presenter and Facility Tour Guide at the NSLS "Science + Sunday" laboratory open house at Brookhaven National Laboratory + skills: + - category: Programming Languages + level: expert + name: Python + - category: Programming Languages + level: expert + name: Cython + teaching: + - course: 'EMCH 552: Intro to Nuclear Engineering' + description: This course is an introduction to nuclear physics. + month: August + organization: University of South Carolina + position: Professor + syllabus: https://drive.google.com/open?id=0BxUpd34yizZreDBCMEJNY2FUbnc + year: 2017 + - course: 'EMCH 558/758: Reactor Power Systems' + description: This course covers conventional reactors. + month: January + organization: University of South Carolina + position: Professor + syllabus: https://docs.google.com/document/d/1uMAx_KFZK9ugYyF6wWtLLWgITVhaTBkAf8-PxiboYdM/edit?usp=sharing + year: 2017 + title: Dr. + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "scopatz", + "aka": [ + "Scopatz", + "Scopatz, A", + "Scopatz, A.", + "Scopatz, A M", + "Anthony Michael Scopatz" + ], + "avatar": "https://avatars1.githubusercontent.com/u/320553?v=3&s=200", + "bio": "Anthony Scopatz is currently an Assistant Professor", + "education": [ + { + "begin_year": 2008, + "degree": "Ph.D. Mechanical Engineering, Nuclear and Radiation Engineering Program", + "department": "apam", + "end_year": 2011, + "group": "ergs", + "institution": "The University of Texas at Austin", + "location": "Austin, TX", + "other": [ + "Adviser: Erich A. Schneider", + "Dissertation: Essential Physics for Fuel Cycle Modeling & Analysis" + ] + }, + { + "begin_year": 2006, + "degree": "M.S.E. Mechanical Engineering, Nuclear and Radiation Engineering Program", + "end_year": 2007, + "institution": "The University of Texas at Austin", + "location": "Austin, TX", + "other": [ + "Adviser: Erich A. Schneider", + "Thesis: Recyclable Uranium Options under the Global Nuclear Energy Partnership" + ] + }, + { + "begin_day": 1, + "begin_month": "Sep", + "begin_year": 2002, + "degree": "B.S. Physics", + "end_day": 20, + "end_month": 5, + "end_year": 2006, + "institution": "University of California, Santa Barbara", + "location": "Santa Barbara, CA", + "other": [ + "Graduated with a Major in Physics and a Minor in Mathematics" + ] + }, + { + "begin_year": 2008, + "degree": "ongoing", + "department": "earth", + "group": "life", + "institution": "solar system", + "location": "land, mostly" + } + ], + "email": "scopatz@cec.sc.edu", + "employment": [ + { + "begin_year": 2015, + "group": "ergs", + "location": "Columbia, SC", + "organization": "The University of South Carolina", + "other": [ + "Cyclus: An agent-based, discrete time nuclear fuel cycle simulator.", + "PyNE: The Nuclear Engineering Toolkit.", + "Website: http://www.ergs.sc.edu/" + ], + "position": "Assistant Professor, Mechanical Engineering Department" + }, + { + "begin_day": 1, + "begin_month": "Jun", + "begin_year": 2013, + "department": "Physics", + "end_day": 15, + "end_month": 3, + "end_year": 2015, + "location": "Madison, WI", + "organization": "CNERG, The University of Wisconsin-Madison", + "other": [ + "Cyclus: An agent-based, discrete time nuclear fuel cycle simulator.", + "PyNE: The Nuclear Engineering Toolkit.", + "Website: https://cnerg.github.io/" + ], + "position": "Associate Scientist, Engineering Physics Department" + }, + { + "begin_day": 1, + "begin_month": "Nov", + "begin_year": 2011, + "end_month": "May", + "end_year": 2013, + "location": "Chicago, IL", + "organization": "The FLASH Center, The University of Chicago", + "other": [ + "NIF: Simulation of magnetic field generation from neutral plasmas using FLASH.", + "CosmoB: Simulation of magnetic field generation from neutral plasmas using FLASH.", + "FLASH4: High-energy density physics capabilities and utilities.", + "Simulated Diagnostics: Schlieren, shadowgraphy, Langmuir probes, etc. from FLASH.", + "OpacPlot: HDF5-based equation of state and opacity file format.", + "Website: http://flash.uchicago.edu/site/" + ], + "position": "Research Scientist, Postdoctoral Scholar", + "status": "PI" + } + ], + "funding": [ + { + "name": "Omega Laser User's Group Travel Award", + "value": 1100, + "year": 2013 + }, + { + "name": "NIF User's Group Travel Award", + "value": 1150, + "year": 2013 + } + ], + "google_scholar_url": "https://scholar.google.com/citations?user=dRm8f", + "home_address": { + "city": "The big apple", + "state": "plasma", + "street": "123 Wallabe Ln", + "zip": "007" + }, + "initials": "AMS", + "membership": [ + { + "begin_year": 2006, + "organization": "American Nuclear Society", + "position": "Member" + }, + { + "begin_year": 2013, + "organization": "Python Software Foundation", + "position": "Fellow" + } + ], + "name": "Anthony Scopatz", + "orcid_id": "0000-0002-9432-4248", + "position": "professor", + "research_focus_areas": [ + { + "begin_year": 2010, + "description": "software applied to nuclear engineering and life" + } + ], + "service": [ + { + "name": "Master of Ceremonies and Organizer Brown University \"Chemistry: Believe it or Not\" public chemistry demonstration", + "year": 2013 + }, + { + "begin_year": 2012, + "end_year": 2014, + "name": "Renewable Energy Presenter and Facility Tour Guide at the NSLS \"Science Sunday\" laboratory open house at Brookhaven National Laboratory" + } + ], + "skills": [ + { + "category": "Programming Languages", + "level": "expert", + "name": "Python" + }, + { + "category": "Programming Languages", + "level": "expert", + "name": "Cython" + } + ], + "teaching": [ + { + "course": "EMCH 552: Intro to Nuclear Engineering", + "description": "This course is an introduction to nuclear physics.", + "month": "August", + "organization": "University of South Carolina", + "position": "Professor", + "syllabus": "https://drive.google.com/open?id=0BxUpd34yizZreDBCMEJNY2FUbnc", + "year": 2017 + }, + { + "course": "EMCH 558/758: Reactor Power Systems", + "description": "This course covers conventional reactors.", + "month": "January", + "organization": "University of South Carolina", + "position": "Professor", + "syllabus": "https://docs.google.com/document/d/1uMAx_KFZK9ugYyF6wWtLLWgITVhaTBkAf8-PxiboYdM/edit?usp=sharing", + "year": 2017 + } + ], + "title": "Dr." + } diff --git a/doc/source/collections/presentations.rst b/doc/source/collections/presentations.rst new file mode 100644 index 000000000..ae5c9cc96 --- /dev/null +++ b/doc/source/collections/presentations.rst @@ -0,0 +1,185 @@ +Presentations +============= +This collection describes presentations that groupmembers make at conferences, symposia, seminars andso on. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, unique id for the presentation, required +:abstract: string, abstract of the presentation, optional +:authors: ['string', 'list'], Author list., required +:begin_day: integer, optional +:begin_month: ['string', 'integer'], required +:begin_year: integer, year the conference or trip begins., required +:department: string, department of the institution where thepresentation will be made, if applicable. should be discoverable in institutions., optional +:end_day: integer, optional +:end_month: ['string', 'integer'], optional +:end_year: integer, year the conference or trip ends, optional +:institution: string, institution where thepresentation will be made, if applicable., optional +:location: string, city and {state or country} of meeting, optional +:meeting_name: string, full name of the conference or meeting. If it is a departmental seminar or colloquium, write Seminaror Colloquium and fill in department and institution fields, optional +:notes: ['list', 'string'], any reminder or memory aid about anything, optional +:project: ['string', 'list'], project or list of projects that this presentation is associated with. Should be discoverable in projects collection, optional +:status: string, Is the application in prep or submitted, was the invitation accepted or declined, was the trip cancelled?, required + + Allowed values: + * in-prep + * submitted + * accepted + * declined + * cancelled +:title: string, title of the presentation, required +:type: string, type of presentation, required + + Allowed values: + * award + * colloquium + * contributed_oral + * invited + * keynote + * plenary + * poster + * seminar + + +YAML Example +------------ + +.. code-block:: yaml + + 18sb04_kentstate: + abstract: We made the case for local structure + authors: + - scopatz + begin_day: 22 + begin_month: May + begin_year: 2018 + department: physics + end_day: 22 + end_month: 5 + end_year: 2018 + institution: columbiau + notes: + - what a week! + project: 18kj_conservation + status: accepted + title: Nanostructure challenges and successes from 16th Century warships to 21st + Century energy + type: colloquium + 18sb_nslsii: + abstract: We pulled apart graphite with tape + authors: + - scopatz + begin_day: 22 + begin_month: 5 + begin_year: 2018 + department: apam + end_day: 22 + end_month: 5 + end_year: 2018 + institution: columbiau + location: Upton NY + meeting_name: 2018 NSLS-II and CFN Users Meeting + notes: + - We hope the weather will be sunny + - if the weather is nice we will go to the beach + project: 18sob_clustermining + status: accepted + title: 'ClusterMining: extracting core structures of metallic nanoparticles from + the atomic pair distribution function' + type: poster + 18sb_this_and_that: + abstract: We pulled apart graphite with tape + authors: + - scopatz + begin_day: 22 + begin_month: 5 + begin_year: 2018 + department: apam + institution: columbiau + location: Upton NY + meeting_name: Meeting to check flexibility on dates + notes: + - We hope the weather will be sunny + - if the weather is nice we will go to the beach + project: 18sob_clustermining + status: accepted + title: Graphitic Dephenestration + type: award + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "18sb04_kentstate", + "abstract": "We made the case for local structure", + "authors": [ + "scopatz" + ], + "begin_day": 22, + "begin_month": "May", + "begin_year": 2018, + "department": "physics", + "end_day": 22, + "end_month": 5, + "end_year": 2018, + "institution": "columbiau", + "notes": [ + "what a week!" + ], + "project": "18kj_conservation", + "status": "accepted", + "title": "Nanostructure challenges and successes from 16th Century warships to 21st Century energy", + "type": "colloquium" + } + { + "_id": "18sb_nslsii", + "abstract": "We pulled apart graphite with tape", + "authors": [ + "scopatz" + ], + "begin_day": 22, + "begin_month": 5, + "begin_year": 2018, + "department": "apam", + "end_day": 22, + "end_month": 5, + "end_year": 2018, + "institution": "columbiau", + "location": "Upton NY", + "meeting_name": "2018 NSLS-II and CFN Users Meeting", + "notes": [ + "We hope the weather will be sunny", + "if the weather is nice we will go to the beach" + ], + "project": "18sob_clustermining", + "status": "accepted", + "title": "ClusterMining: extracting core structures of metallic nanoparticles from the atomic pair distribution function", + "type": "poster" + } + { + "_id": "18sb_this_and_that", + "abstract": "We pulled apart graphite with tape", + "authors": [ + "scopatz" + ], + "begin_day": 22, + "begin_month": 5, + "begin_year": 2018, + "department": "apam", + "institution": "columbiau", + "location": "Upton NY", + "meeting_name": "Meeting to check flexibility on dates", + "notes": [ + "We hope the weather will be sunny", + "if the weather is nice we will go to the beach" + ], + "project": "18sob_clustermining", + "status": "accepted", + "title": "Graphitic Dephenestration", + "type": "award" + } diff --git a/doc/source/collections/projects.rst b/doc/source/collections/projects.rst new file mode 100644 index 000000000..385044299 --- /dev/null +++ b/doc/source/collections/projects.rst @@ -0,0 +1,80 @@ +Projects +======== +This collection describes the research group projects. This is normally public data. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, Unique project identifier., required +:description: string, brief project description., required +:grant: string, Grant id if there is a grant supporting this project, optional +:logo: string, URL to the project logo, optional +:name: string, name of the project., required +:other: ['list', 'string'], other information about the project, optional +:repo: string, URL of the source code repo, if available, optional +:team: list, People who are/have been working on this project., required + + :type: dict, optional + + :begin_month: ['string', 'integer'], optional + :begin_year: integer, optional + :end_month: ['string', 'integer'], optional + :end_year: integer, optional + :name: string, optional + :position: string, optional +:website: string, URL of the website., required + + +YAML Example +------------ + +.. code-block:: yaml + + Cyclus: + description: Agent-Based Nuclear Fuel Cycle Simulator + grant: dmref15 + logo: http://fuelcycle.org/_static/big_c.png + name: Cyclus + other: + - Discrete facilities with discrete material transactions + - Low barrier to entry, rapid payback to adoption + repo: https://github.com/cyclus/cyclus/ + team: + - begin_month: June + begin_year: 2013 + end_month: July + end_year: 2015 + name: Anthony Scopatz + position: Project Lead + website: http://fuelcycle.org/ + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "Cyclus", + "description": "Agent-Based Nuclear Fuel Cycle Simulator", + "grant": "dmref15", + "logo": "http://fuelcycle.org/_static/big_c.png", + "name": "Cyclus", + "other": [ + "Discrete facilities with discrete material transactions", + "Low barrier to entry, rapid payback to adoption" + ], + "repo": "https://github.com/cyclus/cyclus/", + "team": [ + { + "begin_month": "June", + "begin_year": 2013, + "end_month": "July", + "end_year": 2015, + "name": "Anthony Scopatz", + "position": "Project Lead" + } + ], + "website": "http://fuelcycle.org/" + } diff --git a/doc/source/collections/proposalReviews.rst b/doc/source/collections/proposalReviews.rst new file mode 100644 index 000000000..8c31cff00 --- /dev/null +++ b/doc/source/collections/proposalReviews.rst @@ -0,0 +1,252 @@ +Proposalreviews +=============== +This collection contains reviews of funding proposals + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: ('string', 'integer', 'float'), ID, e.g. 1906_doe_example, required +:adequacy_of_resources: list, Are the resources of the PI adequate, required +:agency: string, currently nsf or doe, optional + + Allowed values: + * nsf + * doe +:competency_of_team: list, Is the team competent, required +:doe_appropriateness_of_approach: list, Appropriateness of Research. only used if agency is doe., optional +:doe_reasonableness_of_budget: list, Reasonableness of budget. only used if agency is doe., optional +:doe_relevance_to_program_mission: list, Relevance to program mission. only used if agency is doe., optional +:does_how: list, How will the research be done, required +:does_what: string, What will the team do, required +:freewrite: list, Anything and this will appear in the built documentright before the summary. This section often used for extra review criteria for the particular proposal, optional +:goals: list, What are the main goals of the proposed research, required +:importance: list, The importance of the Research, required +:institution: string, The institution of the lead PI, required +:month: ['string', 'integer'], The month the review was submitted, required +:names: ['list', 'string'], The names of the PIs, required +:nsf_broader_impacts: list, The broader impacts of the research. Only used if agency is nsf, optional +:nsf_create_original_transformative: list, Answer to the question how the work is creative, original or transformative. Only used if agency is nsf, optional +:nsf_plan_good: list, Is the plan good? Only used if agency is nsf, optional +:nsf_pot_to_Advance_knowledge: list, Answer to the question how the work will advanceknowledge. Only used if agency is nsf, optional +:nsf_pot_to_benefit_society: list, Answer to the question how the work has the potentialto benefit society. Only used if agency is nsf, optional +:requester: string, Name of the program officer who requested the review, required +:reviewer: string, short name of the reviewer. Will be used in the filename of the resulting text file, required +:status: string, the status of the review, optional + + Allowed values: + * invited + * accepted + * declined + * downloaded + * inprogress + * submitted +:summary: string, Summary statement, required +:title: string, The title of the proposal, required +:year: integer, The year the review was submitted, required + + +YAML Example +------------ + +.. code-block:: yaml + + 1906doeExample: + adequacy_of_resources: + - The resources available to the PI seem adequate + agency: doe + competency_of_team: + - super competent! + doe_appropriateness_of_approach: + - The proposed approach is highly innovative + doe_reasonableness_of_budget: + - They could do it with half the money + doe_relevance_to_program_mission: + - super relevant + does_how: + - they will find the cause of Malaria + - when they find it they will determine a cure + does_what: Find a cure for Malaria + freewrite: + - I can put extra things here, such as special instructions from the + - program officer + goals: + - The goals of the proposal are to put together a team to find a curefor Malaria, + and then to find it + importance: + - save lives + - lift people from poverty + institution: columbiau + month: May + names: + - B. Cause + - A.N. Effect + nsf_broader_impacts: [] + nsf_create_original_transformative: [] + nsf_plan_good: [] + nsf_pot_to_Advance_knowledge: [] + nsf_pot_to_benefit_society: [] + requester: Lane Wilson + reviewer: sbillinge + status: submitted + summary: dynamite proposal + title: A stunning new way to cure Malaria + year: 2019 + 1906nsfExample: + adequacy_of_resources: + - The resources available to the PI seem adequate + agency: nsf + competency_of_team: + - super competent! + doe_appropriateness_of_approach: [] + doe_reasonableness_of_budget: [] + doe_relevance_to_program_mission: [] + does_how: + - they will find the cause of Poverty + - when they find it they will determine a cure + does_what: Find a cure for Poverty + freewrite: + - I can put extra things here, such as special instructions from the + - program officer + goals: + - The goals of the proposal are to put together a team to find a curefor Poverty, + and then to find it + importance: + - save lives + - lift people from poverty + institution: upenn + month: May + names: + - A Genius + nsf_broader_impacts: + - Poor people will be made unpoor + nsf_create_original_transformative: + - transformative because lives will be transformed + nsf_plan_good: + - I don't see any issues with the plan + - it should be very straightforward + nsf_pot_to_Advance_knowledge: + - This won't advance knowledge at all + nsf_pot_to_benefit_society: + - Society will benefit by poor people being made unpoor if they want to be + requester: Tessemer Guebre + reviewer: sbillinge + status: invited,accepted,declined,downloaded,inprogress,submitted + summary: dynamite proposal + title: A stunning new way to cure Poverty + year: 2019 + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "1906doeExample", + "adequacy_of_resources": [ + "The resources available to the PI seem adequate" + ], + "agency": "doe", + "competency_of_team": [ + "super competent!" + ], + "doe_appropriateness_of_approach": [ + "The proposed approach is highly innovative" + ], + "doe_reasonableness_of_budget": [ + "They could do it with half the money" + ], + "doe_relevance_to_program_mission": [ + "super relevant" + ], + "does_how": [ + "they will find the cause of Malaria", + "when they find it they will determine a cure" + ], + "does_what": "Find a cure for Malaria", + "freewrite": [ + "I can put extra things here, such as special instructions from the", + "program officer" + ], + "goals": [ + "The goals of the proposal are to put together a team to find a curefor Malaria, and then to find it" + ], + "importance": [ + "save lives", + "lift people from poverty" + ], + "institution": "columbiau", + "month": "May", + "names": [ + "B. Cause", + "A.N. Effect" + ], + "nsf_broader_impacts": [], + "nsf_create_original_transformative": [], + "nsf_plan_good": [], + "nsf_pot_to_Advance_knowledge": [], + "nsf_pot_to_benefit_society": [], + "requester": "Lane Wilson", + "reviewer": "sbillinge", + "status": "submitted", + "summary": "dynamite proposal", + "title": "A stunning new way to cure Malaria", + "year": 2019 + } + { + "_id": "1906nsfExample", + "adequacy_of_resources": [ + "The resources available to the PI seem adequate" + ], + "agency": "nsf", + "competency_of_team": [ + "super competent!" + ], + "doe_appropriateness_of_approach": [], + "doe_reasonableness_of_budget": [], + "doe_relevance_to_program_mission": [], + "does_how": [ + "they will find the cause of Poverty", + "when they find it they will determine a cure" + ], + "does_what": "Find a cure for Poverty", + "freewrite": [ + "I can put extra things here, such as special instructions from the", + "program officer" + ], + "goals": [ + "The goals of the proposal are to put together a team to find a curefor Poverty, and then to find it" + ], + "importance": [ + "save lives", + "lift people from poverty" + ], + "institution": "upenn", + "month": "May", + "names": [ + "A Genius" + ], + "nsf_broader_impacts": [ + "Poor people will be made unpoor" + ], + "nsf_create_original_transformative": [ + "transformative because lives will be transformed" + ], + "nsf_plan_good": [ + "I don't see any issues with the plan", + "it should be very straightforward" + ], + "nsf_pot_to_Advance_knowledge": [ + "This won't advance knowledge at all" + ], + "nsf_pot_to_benefit_society": [ + "Society will benefit by poor people being made unpoor if they want to be" + ], + "requester": "Tessemer Guebre", + "reviewer": "sbillinge", + "status": "invited,accepted,declined,downloaded,inprogress,submitted", + "summary": "dynamite proposal", + "title": "A stunning new way to cure Poverty", + "year": 2019 + } diff --git a/doc/source/collections/proposals.rst b/doc/source/collections/proposals.rst new file mode 100644 index 000000000..a3c1a95eb --- /dev/null +++ b/doc/source/collections/proposals.rst @@ -0,0 +1,244 @@ +Proposals +========= +This collection represents proposals that have been submitted by the group. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: ('string', 'integer', 'float'), short representation, such as this-is-my-name, required +:amount: ('integer', 'float'), value of award, required +:authors: ['list', 'string'], other investigator names, required +:begin_day: integer, start day of the proposed grant, optional +:begin_month: ['string', 'integer'], start month of the proposed grant, optional +:begin_year: integer, start year of the proposed grant, optional +:call_for_proposals: string, optional +:cpp_info: dict, extra information needed for building current and pending form , optional + + :cppflag: boolean, optional + :other_agencies_submitted: ['string', 'boolean'], optional + :institution: string, place where the proposed grant will be located, optional + :person_months_academic: ['float', 'integer'], optional + :person_months_summer: ['float', 'integer'], optional + :project_scope: string, optional +:currency: string, typically '$' or 'USD', required +:day: integer, day that the proposal was submitted, required +:due_date: string, day that the proposal is due, optional +:duration: ('integer', 'float'), number of years, required +:end_day: ('string', 'integer'), end day of the proposed grant, optional +:end_month: ['string', 'integer'], end month of the proposed grant, optional +:end_year: integer, end year of the proposed grant, optional +:full: dict, full body of the proposal, optional +:funder: string, who will fund the proposalas funder in grants, optional +:month: ['string', 'integer'], month that the proposal was submitted, required +:notes: ['string', 'list'], anything you want to note, optional +:pi: string, principal investigator name, required +:pre: dict, Information about the pre-proposal, optional +:status: string, e.g. 'pending', 'accepted', 'rejected', required + + Allowed values: + * pending + * declined + * accepted + * in-prep + * submitted +:team: list, information about the team members participating in the grant., optional + + :type: dict, optional + + :cv: string, optional + :email: string, optional + :institution: string, optional + :name: string, optional + :position: string, optional + :subaward_amount: ('integer', 'float'), optional +:title: string, actual title of proposal, required +:title_short: string, short title of proposal, optional +:year: integer, Year that the proposal was submitted, required + + +YAML Example +------------ + +.. code-block:: yaml + + dmref15: + amount: 982785.0 + authors: + - qdu + - dhsu + - sbillinge + begin_day: 1 + begin_month: May + begin_year: 2018 + call_for_proposals: http://www.nsf.gov/pubs/2014/nsf14591/nsf14591.htm + cpp_info: + cppflag: true + institution: Columbia University + other_agencies_submitted: None + person_months_academic: 0 + person_months_summer: 1 + project_scope: lots to do but it doesn't overlap with any other of my grants + currency: USD + day: 2 + duration: 3 + end_day: 1 + end_month: May + end_year: 2019 + funder: NSF + month: february + notes: Quite an idea + pi: Simon Billinge + status: accepted + team: + - institution: Columbia Unviersity + name: qdu + position: Co-PI + - institution: Columbia Unviersity + name: dhsu + position: Co-PI + - institution: Columbia Unviersity + name: sbillinge + position: PI + subaward_amount: 330000.0 + title: 'DMREF: Novel, data validated, nanostructure determination methods for accelerating + materials discovery' + title_short: DMREF nanostructure + year: 2015 + mypropsal: + amount: 1000000.0 + authors: + - Anthony Scopatz + - Robert Flanagan + begin_day: 1 + begin_month: May + begin_year: 2030 + currency: USD + day: 18 + duration: 3 + end_day: 31 + end_month: December + end_year: 2030 + full: + benefit_of_collaboration: http://pdf.com/benefit_of_collaboration + cv: + - http://pdf.com/scopatz-cv + - http://pdf.com/flanagan-cv + narrative: http://some.com/pdf + month: Aug + notes: Quite an idea + pi: Anthony Scopatz + pre: + benefit_of_collaboration: http://pdf.com/benefit_of_collaboration + cv: + - http://pdf.com/scopatz-cv + - http://pdf.com/flanagan-cv + day: 2 + month: Aug + narrative: http://some.com/pdf + year: 1998 + status: submitted + title: A very fine proposal indeed + year: 1999 + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "dmref15", + "amount": 982785.0, + "authors": [ + "qdu", + "dhsu", + "sbillinge" + ], + "begin_day": 1, + "begin_month": "May", + "begin_year": 2018, + "call_for_proposals": "http://www.nsf.gov/pubs/2014/nsf14591/nsf14591.htm", + "cpp_info": { + "cppflag": true, + "institution": "Columbia University", + "other_agencies_submitted": "None", + "person_months_academic": 0, + "person_months_summer": 1, + "project_scope": "lots to do but it doesn't overlap with any other of my grants" + }, + "currency": "USD", + "day": 2, + "duration": 3, + "end_day": 1, + "end_month": "May", + "end_year": 2019, + "funder": "NSF", + "month": "february", + "notes": "Quite an idea", + "pi": "Simon Billinge", + "status": "accepted", + "team": [ + { + "institution": "Columbia Unviersity", + "name": "qdu", + "position": "Co-PI" + }, + { + "institution": "Columbia Unviersity", + "name": "dhsu", + "position": "Co-PI" + }, + { + "institution": "Columbia Unviersity", + "name": "sbillinge", + "position": "PI", + "subaward_amount": 330000.0 + } + ], + "title": "DMREF: Novel, data validated, nanostructure determination methods for accelerating materials discovery", + "title_short": "DMREF nanostructure", + "year": 2015 + } + { + "_id": "mypropsal", + "amount": 1000000.0, + "authors": [ + "Anthony Scopatz", + "Robert Flanagan" + ], + "begin_day": 1, + "begin_month": "May", + "begin_year": 2030, + "currency": "USD", + "day": 18, + "duration": 3, + "end_day": 31, + "end_month": "December", + "end_year": 2030, + "full": { + "benefit_of_collaboration": "http://pdf.com/benefit_of_collaboration", + "cv": [ + "http://pdf.com/scopatz-cv", + "http://pdf.com/flanagan-cv" + ], + "narrative": "http://some.com/pdf" + }, + "month": "Aug", + "notes": "Quite an idea", + "pi": "Anthony Scopatz", + "pre": { + "benefit_of_collaboration": "http://pdf.com/benefit_of_collaboration", + "cv": [ + "http://pdf.com/scopatz-cv", + "http://pdf.com/flanagan-cv" + ], + "day": 2, + "month": "Aug", + "narrative": "http://some.com/pdf", + "year": 1998 + }, + "status": "submitted", + "title": "A very fine proposal indeed", + "year": 1999 + } diff --git a/doc/source/collections/refereeReports.rst b/doc/source/collections/refereeReports.rst new file mode 100644 index 000000000..940f38830 --- /dev/null +++ b/doc/source/collections/refereeReports.rst @@ -0,0 +1,119 @@ +Refereereports +============== +This is a collection of information that will be be used to build a referee report. This should probably be private. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, the ID, required +:claimed_found_what: list, What the authors claim to have found, required + + :type: string, required +:claimed_why_important: list, What importance the authors claim, required + + :type: string, required +:did_how: list, How the study was done, required + + :type: string, required +:did_what: list, What the study was, required + + :type: string, required +:editor_eyes_only: string, Comments you don't want passed to the author, optional +:final_assessment: list, Summary of impressions of the study, required + + :type: string, required +:first_author_last_name: string, Last name of first author will be referred to with et al., required +:freewrite: string, Things that you want to add that don't fit into any category above, optional +:journal: string, name of the journal, required +:month: ['string', 'integer'], month when the review is being written, required +:recommendation: string, Your publication recommendation, required + + Allowed values: + * reject + * asis + * smalledits + * diffjournal + * majoredits +:reviewer: string, name of person reviewing the paper, required +:status: string, Where you are with the review, required + + Allowed values: + * accepted + * declined + * downloaded + * inprogress + * submitted +:title: string, title of the paper under review, required +:validity_assessment: list, List of impressions of the validity of the claims, required + + :type: string, required +:year: string, year when the review is being done, required + + +YAML Example +------------ + +.. code-block:: yaml + + 1902nature: + claimed_found_what: + - gravity waves + claimed_why_important: + - more money for ice cream + did_how: + - measured with a ruler + did_what: + - found a much cheaper way to measure gravity waves + editor_eyes_only: to be honest, I don't believe a word of it + final_assessment: + - The authors should really start over + first_author_last_name: Wingit + freewrite: this comment didn't fit anywhere above + journal: Nature + month: 2 + recommendation: reject + reviewer: sbillinge + status: submitted + title: a ruler approach to measuring gravity waves + validity_assessment: + - complete rubbish + year: '2019' + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "1902nature", + "claimed_found_what": [ + "gravity waves" + ], + "claimed_why_important": [ + "more money for ice cream" + ], + "did_how": [ + "measured with a ruler" + ], + "did_what": [ + "found a much cheaper way to measure gravity waves" + ], + "editor_eyes_only": "to be honest, I don't believe a word of it", + "final_assessment": [ + "The authors should really start over" + ], + "first_author_last_name": "Wingit", + "freewrite": "this comment didn't fit anywhere above", + "journal": "Nature", + "month": 2, + "recommendation": "reject", + "reviewer": "sbillinge", + "status": "submitted", + "title": "a ruler approach to measuring gravity waves", + "validity_assessment": [ + "complete rubbish" + ], + "year": "2019" + } diff --git a/doc/source/collections/students.rst b/doc/source/collections/students.rst new file mode 100644 index 000000000..580f794ed --- /dev/null +++ b/doc/source/collections/students.rst @@ -0,0 +1,41 @@ +Students +======== +This is a collection of student names and metadata. This should probably be private. + +Schema +------ +The following lists key names mapped to its type and meaning for each entry. + +:_id: string, short representation, such as this-is-my-name, required +:aka: ('list', 'string'), list of aliases, optional + + :type: string, optional +:email: string, email address, optional +:university_id: string, The university identifier for the student, optional + + +YAML Example +------------ + +.. code-block:: yaml + + Human A. Person: + aka: + - H. A. Person + email: haperson@uni.edu + university_id: HAP42 + + +JSON/Mongo Example +------------------ + +.. code-block:: json + + { + "_id": "Human A. Person", + "aka": [ + "H. A. Person" + ], + "email": "haperson@uni.edu", + "university_id": "HAP42" + }