From 443f31352536541c31f9be81910f45f1146d14e8 Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Sun, 2 Jun 2024 06:03:46 -0400 Subject: [PATCH 1/3] professional summary and synopsis added to papers --- news/citations.rst | 24 ++++++++++++++++++++++++ regolith/builders/grantreportbuilder.py | 4 ++-- regolith/templates/grantreport.txt | 7 +++++-- 3 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 news/citations.rst diff --git a/news/citations.rst b/news/citations.rst new file mode 100644 index 000000000..b90385f45 --- /dev/null +++ b/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:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* spacing in names in citations in grant-reports + +**Security:** + +* diff --git a/regolith/builders/grantreportbuilder.py b/regolith/builders/grantreportbuilder.py index 4a91f94a3..379e2dbe1 100644 --- a/regolith/builders/grantreportbuilder.py +++ b/regolith/builders/grantreportbuilder.py @@ -81,7 +81,7 @@ def latex(self): report_dates = {'begin_date': rp_start_date, 'end_date': rp_end_date} print(f"INFO: generating report for grant {grant_id} for the period" - f"from {rp_start_date} to {rp_end_date})") + f" from {rp_start_date} to {rp_end_date})") # Get prum associated to grant and active during reporting period @@ -158,7 +158,7 @@ def latex(self): grant_id in publ.get("grant", "")] for publ in publications: - formatted_authors = [HumanName(name).full_name + formatted_authors = [f" {HumanName(name).full_name}" for name in publ.get("authors",[])] publ["authors"] = formatted_authors # Participants/Organizations diff --git a/regolith/templates/grantreport.txt b/regolith/templates/grantreport.txt index dcc5416ad..8218fb8ac 100644 --- a/regolith/templates/grantreport.txt +++ b/regolith/templates/grantreport.txt @@ -92,10 +92,13 @@ 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') }} + Synopsis: {{ publ.get('synopsis','') }} + professional Summary: {{ publ.get('professional_summary','') }} + public Summary: {{ publ.get('public_summary','') }} {% endfor -%}} {{ hline }} @@ -148,4 +151,4 @@ Significant changes in use or care of human subjects Significant changes in use or care of vertebrate animals -Significant changes in use or care of biohazards \ No newline at end of file +Significant changes in use or care of biohazards From 12edae81186e23a89d5a68140b2da8e30d52557f Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Sun, 2 Jun 2024 06:06:40 -0400 Subject: [PATCH 2/3] professional summary and synopsis added to papers --- regolith/templates/grantreport.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/regolith/templates/grantreport.txt b/regolith/templates/grantreport.txt index 8218fb8ac..a8c0a8fe2 100644 --- a/regolith/templates/grantreport.txt +++ b/regolith/templates/grantreport.txt @@ -99,6 +99,7 @@ Products Synopsis: {{ publ.get('synopsis','') }} professional Summary: {{ publ.get('professional_summary','') }} public Summary: {{ publ.get('public_summary','') }} + acknowledgement statement: {{ publ.get('ackno','') }} {% endfor -%}} {{ hline }} From 629650a56ad900f45694bd7202f56d34f71d8189 Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Sat, 8 Jun 2024 09:56:42 -0400 Subject: [PATCH 3/3] now buids impacts from grant goals and highlights --- regolith/builders/grantreportbuilder.py | 1 + regolith/schemas.json | 5 ++ regolith/templates/grantreport.txt | 97 +++++++++++++++++-------- 3 files changed, 72 insertions(+), 31 deletions(-) diff --git a/regolith/builders/grantreportbuilder.py b/regolith/builders/grantreportbuilder.py index 379e2dbe1..1f2c43c60 100644 --- a/regolith/builders/grantreportbuilder.py +++ b/regolith/builders/grantreportbuilder.py @@ -209,6 +209,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, end_date=end_date_str, majorActivities=major_activities, diff --git a/regolith/schemas.json b/regolith/schemas.json index b84a75988..54cf123b6 100644 --- a/regolith/schemas.json +++ b/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" } diff --git a/regolith/templates/grantreport.txt b/regolith/templates/grantreport.txt index a8c0a8fe2..89cc8ba61 100644 --- a/regolith/templates/grantreport.txt +++ b/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')}} @@ -63,11 +37,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? @@ -96,11 +70,15 @@ Products {{ publ.get('journal') }}, {{ publ.get('volume') }}, pp. {{ publ.get('pages') }} {{ publ.get('month') }}/{{ publ.get('year') }} {{ publ.get('doi') }} + Synopsis: {{ publ.get('synopsis','') }} + professional Summary: {{ publ.get('professional_summary','') }} + public Summary: {{ publ.get('public_summary','') }} + acknowledgement statement: {{ publ.get('ackno','') }} -{% endfor -%}} +{% endfor -%} {{ hline }} Participants/Organizations @@ -125,20 +103,77 @@ Impacts {{ hline }} 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 {{ hline }}