citations

news/citations.rst

@@ -0,0 +1,24 @@
+**Added:**
+
+* article synopsis and professional summary added to grant-report citation list
+* acknowledgement statement added to grant-report citation list
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* spacing in names in citations in grant-reports
+
+**Security:**
+
+* <news item>

src/regolith/builders/grantreportbuilder.py

@@ -163,7 +163,7 @@ def latex(self):
         publications = [publ for publ in self.gtx["citations"] if grant_id in publ.get("grant", "")]
 
         for publ in publications:
-            formatted_authors = [HumanName(name).full_name for name in publ.get("authors", [])]
+            formatted_authors = [f" {HumanName(name).full_name}" for name in publ.get("authors", [])]
             publ["authors"] = formatted_authors
         # Participants/Organizations
         participants = []
@@ -205,6 +205,7 @@ def latex(self):
         self.render(
             "grantreport.txt",
             f"{grant_id}_report_{begin_date_str}_{end_date_str}.txt",
+            grant=grant,
             begin_date=begin_date_str,
             newline="\n",
             end_date=end_date_str,

src/regolith/schemas.json

@@ -744,6 +744,11 @@
                     "year": {"required": false, "type": "integer"},
                     "month": {"required": false, "type": "integer"},
                     "description": {
+                        "required": false,
+                        "type": "string",
+                        "description": "any tags for the type of the highlight.  Use any that you want but ones currently used are (principal_discipline, other_discipline,human_resource_development, physical_infrastructure, institutional_infrastructure, information_infrastructure, technology_transfer, broader_society) which correspond to US DOE/NSF progress reports"
+                    },
+                    "tags": {
                         "required": false,
                         "type": "string"
                     }

src/regolith/templates/grantreport.txt

@@ -4,39 +4,13 @@ Accomplishments
 {{ hline }}
 * What are the major goals of the project?
 {{ hline }}
-In real-world applications, materials are rarely perfect crystals and their properties
-depend sensitively on defects, nanoscale structures, interfaces, surfaces and multi-scale
-heterogeneities. A major challenge is to gain a greater understanding of how such
-"imperfect" materials operate, including on different length and time-scales. In situations
-as complicated as this it is essential to validate theories against experiment, and vice versa.
-A more tightly coupled partnership between experiment and theory is needed, having its roots
-in information theory: the models need to capture all the physics of the problem become more
-complicated, while at the same time the information content of experimental data is reduced,
-due to lower resolution from finite size effects, defects, the presence of multiple components
-with overlapping problems, which yield unreliable and non-unique solutions, a bottleneck to
-predictive materials discovery. We will develop novel mathematical approaches to address this
-problem. We will study as a test case the nanostructure inverse problem (NIP), a well defined
-but generally ill-posed materials inverse problem; however, the methods that we develop will
-have much broader applicability in the world of materials discovery.
-
-Goal 1: Develop databases of nanostructure data from model systems
-Goal 2: Develop data analytic and stochastic optimization methodologies for robust
-nanostructure solutions
-Goal 3: Develop software infrastructure for nanostructure modeling that use the databases
-and the new methodologies for nanostructure solution
-Goal 4: Apply this to real scientific problems
+{{ grant.get('narrative') | replace('\n', '\n') }}
 
 {{ hline }}
 * What was accomplished under these goals (you must provide information for
 at least one of the 4 categories below)?
 {{ hline }}
 - Major Activities (currently worked on projecta):
-PDF in the cloud (PDFitc): Development of a web-based service for determining
-structures from measured PDFs given known structures in structural databases
-xpdTools, xpdAcq, xpdAn, xpdView: Software tools for streaming data analysis
-and visualization of diffraction data from the XPD diffractometer at NSLS-II
-synchrotron. The tools can also be used to analyze data from other diffraction
-beamlines.
 {{ hline }}
 {%- for prum in majorActivities %}
     {{ prum.get('_id') }}| {{ prum.get('name') }}| {{prum.get('lead')}}
@@ -48,8 +22,7 @@ beamlines.
 {% endfor -%}
 
 - Specific Objectives:
-PDF in the cloud (PDFitc): Development of a web-based service for determining
-structures from measured PDFs given known structures in structural databases
+
 
 - Significant Results (finished projecta):
 {%- for prum in significantResults %}
@@ -63,11 +36,11 @@ Key outcomes or Other achievements:
 {%- for opportunity in trainingAndProfessionalDevelopment %}
     - Authors: {{ opportunity.get('authors') }}
     - Title: {{ opportunity.get('title') }}
-    - Location: {{ opportunity.get('meeting_name') }}
-{% endfor -%}}
+    - Location: {{ opportunity.get('meeting_name') }}, {{ opportunity.get('location') }}
+{% endfor -%}
 {%- for thesis in defendedTheses %}
     {{thesis}} wrote and successfully defended their thesis.
-{% endfor -%}}
+{% endfor %}
 
 {{ hline }}
 * How have the results been disseminated to communities of interest?
@@ -92,48 +65,103 @@ Products
 {{ hline }}
 {%- for publ in products %}
     - {{ publ.get('title') }}
-      {% for person in publ.get('author') -%}{{ person }}, {%- endfor %}
+      {% for person in publ.get('author') %}{{ person }}, {% endfor %}
       {{ publ.get('journal') }}, {{ publ.get('volume') }}, pp. {{ publ.get('pages') }}
       {{ publ.get('month') }}/{{ publ.get('year') }}
       {{ publ.get('doi') }}
-{% endfor -%}}
+
+      Synopsis: {{ publ.get('synopsis','') }}
+
+      professional Summary: {{ publ.get('professional_summary','') }}
+
+      public Summary: {{ publ.get('public_summary','') }}
+
+      acknowledgement statement: {{ publ.get('ackno','') }}
+{% endfor %}
 
 {{ hline }}
 Participants/Organizations
 {{ hline }}
-What individuals have worked on the project?
-
-Name, Most Senior Project Role, Nearest Person Month Worked
+ - What individuals have worked on the project?
+ - Name, Most Senior Project Role, Nearest Person Month Worked
 {% for person in participants %}
     - {{ person.get('name') }}, {{ person.get("position") }},
       email: {{ person.get('email') }}, months on grant this period: {{ person.get("months_on_grant") }}
-{%- endfor -%}}
-
-What International collaborations have there been?
+{%- endfor -%}
 
-What other organizations have been involved as partners?/What other collaborators or contacts have been involved?
-{%- for contact, info in collaborators.items() %}
+- What International collaborations have there been?
+ - What other organizations have been involved as partners?
+ - What other collaborators or contacts have been involved?
+{% for contact, info in collaborators.items() %}
     - {{ info["name"] }} ({{ info["institution"] }})
-{%- endfor -%}}
+{%- endfor -%}
 
 {{ hline }}
 Impacts
 {{ hline }}
-What is the impact on the development of the principal discipline(s) of the project?
-
-What is the impact on other disciplines?
-
-What is the impact on the development of human resources?
-
-What is the impact on physical resources that form infrastructure?
-
-What is the impact on institutional resources that form infrastructure?
-
-What is the impact on information resources that form infrastructure?
-
-What is the impact on technology transfer?
-
-What is the impact on society beyond science and technology?
+- What is the impact on the development of the principal discipline(s) of the project?
+{% if grant.get('impacts',{}).get('principal_discipline',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('principal_discipline',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on other disciplines?
+{% if grant.get('impacts',{}).get('other_discipline',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('other_discipline',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on the development of human resources?
+{% if grant.get('impacts',{}).get('human_resource_development',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('human_resource_development',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on physical resources that form infrastructure?
+{% if grant.get('impacts',{}).get('physical_infrastructure',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('physical_infrastructure',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on institutional resources that form infrastructure?
+{% if grant.get('impacts',{}).get('institutional_infrastructure',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('institutional_infrastructure',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on information resources that form infrastructure?
+{% if grant.get('impacts',{}).get('information_infrastructure',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('information_infrastructure',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on technology transfer?
+{% if grant.get('impacts',{}).get('technology_transfer',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('technology_transfer',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
+
+ - What is the impact on society beyond science and technology?
+{% if grant.get('impacts',{}).get('broader_society',[]) | length > 0 %}
+Projected impacts are
+{% for item in grant.get('impacts',{}).get('broader_society',[]) %}
+ - {{ item }}
+{% endfor %}
+{% endif -%}
 
 {{ hline }}
 Changes/Problems

tests/outputs/grant-report/SymPy-1.1_report_2017-04-01_2018-03-31.txt

@@ -4,39 +4,13 @@ Accomplishments
 ------------------------------------------------------------------------------
 * What are the major goals of the project?
 ------------------------------------------------------------------------------
-In real-world applications, materials are rarely perfect crystals and their properties
-depend sensitively on defects, nanoscale structures, interfaces, surfaces and multi-scale
-heterogeneities. A major challenge is to gain a greater understanding of how such
-"imperfect" materials operate, including on different length and time-scales. In situations
-as complicated as this it is essential to validate theories against experiment, and vice versa.
-A more tightly coupled partnership between experiment and theory is needed, having its roots
-in information theory: the models need to capture all the physics of the problem become more
-complicated, while at the same time the information content of experimental data is reduced,
-due to lower resolution from finite size effects, defects, the presence of multiple components
-with overlapping problems, which yield unreliable and non-unique solutions, a bottleneck to
-predictive materials discovery. We will develop novel mathematical approaches to address this
-problem. We will study as a test case the nanostructure inverse problem (NIP), a well defined
-but generally ill-posed materials inverse problem; however, the methods that we develop will
-have much broader applicability in the world of materials discovery.
-
-Goal 1: Develop databases of nanostructure data from model systems
-Goal 2: Develop data analytic and stochastic optimization methodologies for robust
-nanostructure solutions
-Goal 3: Develop software infrastructure for nanostructure modeling that use the databases
-and the new methodologies for nanostructure solution
-Goal 4: Apply this to real scientific problems
+https://docs.google.com/document/d/1nZxqoL-Ucni_aXLWmXtRDd3IWqW0mZBO65CEvDrsXZM/edit?usp=sharing
 
 ------------------------------------------------------------------------------
 * What was accomplished under these goals (you must provide information for
 at least one of the 4 categories below)?
 ------------------------------------------------------------------------------
 - Major Activities (currently worked on projecta):
-PDF in the cloud (PDFitc): Development of a web-based service for determining
-structures from measured PDFs given known structures in structural databases
-xpdTools, xpdAcq, xpdAn, xpdView: Software tools for streaming data analysis
-and visualization of diffraction data from the XPD diffractometer at NSLS-II
-synchrotron. The tools can also be used to analyze data from other diffraction
-beamlines.
 ------------------------------------------------------------------------------
     sb_firstprojectum| First Projectum| ascopatz
     My first projectum
@@ -47,13 +21,12 @@ beamlines.
         develop a detailed plan with dates
         mergedpr | proposed 
         - Specific Objectives:
-PDF in the cloud (PDFitc): Development of a web-based service for determining
-structures from measured PDFs given known structures in structural databases
+
 
 - Significant Results (finished projecta):Key outcomes or Other achievements:
 ------------------------------------------------------------------------------
 * What opportunities for training and professional development has the project provided?
-------------------------------------------------------------------------------}}
+------------------------------------------------------------------------------
 
 ------------------------------------------------------------------------------
 * How have the results been disseminated to communities of interest?
@@ -75,39 +48,27 @@ structures from measured PDFs given known structures in structural databases
 
 ------------------------------------------------------------------------------
 Products
-------------------------------------------------------------------------------}
+------------------------------------------------------------------------------
 
 ------------------------------------------------------------------------------
 Participants/Organizations
 ------------------------------------------------------------------------------
-What individuals have worked on the project?
-
-Name, Most Senior Project Role, Nearest Person Month Worked
-}
-
-What International collaborations have there been?
-
-What other organizations have been involved as partners?/What other collaborators or contacts have been involved?}
-
+ - What individuals have worked on the project?
+ - Name, Most Senior Project Role, Nearest Person Month Worked
+- What International collaborations have there been?
+ - What other organizations have been involved as partners?
+ - What other collaborators or contacts have been involved?
 ------------------------------------------------------------------------------
 Impacts
 ------------------------------------------------------------------------------
-What is the impact on the development of the principal discipline(s) of the project?
-
-What is the impact on other disciplines?
-
-What is the impact on the development of human resources?
-
-What is the impact on physical resources that form infrastructure?
-
-What is the impact on institutional resources that form infrastructure?
-
-What is the impact on information resources that form infrastructure?
-
-What is the impact on technology transfer?
-
-What is the impact on society beyond science and technology?
-
+- What is the impact on the development of the principal discipline(s) of the project?
+- What is the impact on other disciplines?
+- What is the impact on the development of human resources?
+- What is the impact on physical resources that form infrastructure?
+- What is the impact on institutional resources that form infrastructure?
+- What is the impact on information resources that form infrastructure?
+- What is the impact on technology transfer?
+- What is the impact on society beyond science and technology?
 ------------------------------------------------------------------------------
 Changes/Problems
 ------------------------------------------------------------------------------