From 21967db6c650e3e1b36e6d4631e51b4abf874ec5 Mon Sep 17 00:00:00 2001 From: Patrick Huck Date: Thu, 14 Jun 2018 11:37:18 -0700 Subject: [PATCH] Update and rename doecode.yml to metadata.yml adding to DOECode --- doecode.yml | 85 ---------------------------------------------------- metadata.yml | 44 +++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 85 deletions(-) delete mode 100644 doecode.yml create mode 100644 metadata.yml diff --git a/doecode.yml b/doecode.yml deleted file mode 100644 index 4bc6220cf..000000000 --- a/doecode.yml +++ /dev/null @@ -1,85 +0,0 @@ ---- -#Metadata template for DOECode users -#Version: 1.01 - -#REQUIRED FIELDS - -title: "MPContribs - The Materials Project's Community Contribution Framework" #"type the title of your project using quotation marks" -date: 2014-12-11 #on what date was this code created YYYY-MM-DD -description: | #provide a description of your project - Since its start in 2011, Materials Project (MP, - https://materialsproject.org/) has grown into a world-wide resource for a - materials sciences community of more than 27,000 users who rely on the portal - as a trusted source to accelerate their research. As a result, they wish to - help with MP's efforts by contributing back, but also ask for support in - sharing their experimental and computational datasets alongside MP's curated - results. This provides the opportunity for researchers in both domains to - validate calculations or measurements almost instantaneously and use the - disseminated data for integrated materials studies. - - With the public announcement of our general contribution framework, - MPContribs, we present a sustainable solution for well-curated data - management, organization and dissemination in the context of MP. The - framework serves the purpose of collectively maintaining contributions to - local and MP community databases as annotations to existing MP materials. It - subsequently disseminates them through a generic interactive gateway powered - by Jupyter notebooks or through custom project web apps enabled by the - webtzite app kit. -license: https://github.com/materialsproject/MPContribs/blob/master/LICENSE #give the URL for your license -openSourceProject: 1 -governmentWideReuseProject: 1 -codeRepository: https://github.com/materialsproject/MPContribs #repo URL - -doeIdentifier: - identName: "DOE Contract Number" - identNumber: DEAC02-05CH11231 #type in the DOE Contract Number - -#add to list as needed -developers: -- firstname: Patrick #what is the developer's first name - familyname: Huck #what is the developer's family name - email: phuck@lbl.gov #what is the developer's email - orcID: - identName: "ORCiD" - identNumber: 0000-0001-8237-2227 #type in the developer's ORCiD, please - basedAt: Lawrence Berkeley National Laboratory #current primary workplace - -submittingOrganization: -- orgName: Lawrence Berkeley National Laboratory #What org is submitting this? add to list as needed. -sponsoringOrganization: -- orgName: Lawrence Berkeley National Laboratory #What org funded this project? add to list as needed. -researchOrganization: -- orgName: MIT; UC Berkeley; Duke; U Louvain #What org contributed to this research? add to list as needed. - -#OPTIONAL FIELDS - -keywords: - - #type a keyword/phrase that describes your project, e.g. "Earth Sciences" - - #type another keyword/phrase, e.g. "Groundwater flow" - -#add to list as needed -contributors: -- firstname: - familyname: - email: - orcID: - identName: "ORCiD" - identNumber: #type in orcid - basedAt: #current primary workplace - -doi: - identName: "DOI" - identNumber: #enter in the software DOI - -#repeat field as needed -additionalIdentifier: - identName: #name of the ID type, e.g. "B&R Code" - identNumber: #the alpha/numeric identifier - -countryOfOrigin: #primary location of software development -hasVersion: #url of newer version -isVersionOf: #url of older version -contactPerson: -requirements: #list any requirements -relatedSoftware: #url of related software repo -relatedDocumentation: #url or uri of related docs diff --git a/metadata.yml b/metadata.yml new file mode 100644 index 000000000..3f191c849 --- /dev/null +++ b/metadata.yml @@ -0,0 +1,44 @@ +--- +code_id: 12023 +open_source: true +repository_link: "https://github.com/materialsproject/MPContribs" +accessibility: "OS" +software_type: "S" +developers: +- email: "" + orcid: "" + first_name: "Patrick" + last_name: "Huck" + middle_name: "" + affiliations: + - "Lawrence Berkeley National Laboratory" +contributors: [] +sponsoring_organizations: [] +contributing_organizations: [] +research_organizations: [] +related_identifiers: [] +software_title: "MPContribs" +acronym: "MPContribs" +description: "Since its start in 2011, Materials Project (MP, https://materialsproject.org/)\ + \ has grown into a world-wide resource for a materials sciences community of more\ + \ than 27,000 users who rely on the portal as a trusted source to accelerate their\ + \ research. As a result, they wish to help with MP's efforts by contributing back,\ + \ but also ask for support in sharing their experimental and computational datasets\ + \ alongside MP's curated results. This provides the opportunity for researchers\ + \ in both domains to validate calculations or measurements almost instantaneously\ + \ and use the disseminated data for integrated materials studies.\n\nWith the public\ + \ announcement of our general contribution framework, MPContribs, we present a sustainable\ + \ solution for well-curated data management, organization and dissemination in the\ + \ context of MP. The framework serves the purpose of collectively maintaining contributions\ + \ to local and MP community databases as annotations to existing MP materials. It\ + \ subsequently disseminates them through a generic interactive gateway powered by\ + \ Jupyter notebooks or through custom project web apps enabled by the webtzite app\ + \ kit." +programming_languages: +- "JavaScript" +- "Python" +country_of_origin: "United States" +licenses: +- "MIT License" +date_record_added: "2018-06-14" +date_record_updated: "2018-06-14"