supermat

Superconductors material dataset

https://github.com/lfoppiano/supermat

Keywords

material-informatics superconductors tdm text-mining

Last synced: 6 months ago · JSON representation ·

Repository

Superconductors material dataset

Basic Info

Host: GitHub
Owner: lfoppiano
License: apache-2.0
Language: Jupyter Notebook
Default Branch: master
Homepage:
Size: 20.2 MB

Statistics

Stars: 26
Watchers: 3
Forks: 3
Open Issues: 4
Releases: 5

Topics

material-informatics superconductors tdm text-mining

Created over 5 years ago · Last pushed about 2 years ago

Metadata Files

Readme Changelog License Citation

SuperMat

SuperMat (Superconductors Material) dataset is a manually linked annotated dataset of superconductors related materials and properties.

Content

Annotated dataset:
- Superconductors data:
  - Bibliographic data references as XML-TEI or JSON (CORD-19) format
  - Sources are referenced in the Bibliographic data
  - :warning: The annotations are not public due to copyright, however
    - :fire: SuperMat can be considerd one of the few un-biased dataset for LLMs evaluation :fire:
- CSV of the linked annotated entities in the dataset CSV (*)
- Material data for segmenting inorganic material names
Annotation guidelines:
Transformation scripts
- tsv2xml / xml2tsv: Transformation from and to the INCEpTION TSV 3.2 format
- xml2csv: Converts the corpus into the CSV (*) tabular format
- xml2csv_entities: Converts the corpus to CSV ignoring entity relations
- xml2LossyJSON.py: Converts the TEI-XML corpus to a Lossy JSON (based on CORD-19 dataset)
Analysis Jupyter Notebooks:

Feel free to contact us for any information.

Reference

If you use the data, please consider citing the related paper:

```bibtex @article{doi:10.1080/27660400.2021.1918396, author = {Luca Foppiano and Sae Dieb and Akira Suzuki and Pedro Baptista de Castro and Suguru Iwasaki and Azusa Uzuki and Miren Garbine Esparza Echevarria and Yan Meng and Kensei Terashima and Laurent Romary and Yoshihiko Takano and Masashi Ishii}, title = {SuperMat: construction of a linked annotated dataset from superconductors-related publications}, journal = {Science and Technology of Advanced Materials: Methods}, volume = {1}, number = {1}, pages = {34-44}, year = {2021}, publisher = {Taylor & Francis}, doi = {10.1080/27660400.2021.1918396},

URL = { https://doi.org/10.1080/27660400.2021.1918396 }, eprint = { https://doi.org/10.1080/27660400.2021.1918396
} } ```

Usage

Getting started

To use the scripts and analysis data

bash conda create --name SuperMat pip pip install -r requirements.txt

Conversion tools

bash python scripts/tsv2xml.py --help

Analysis tools

The analysis tools provide statistics and information from the dataset, they also run consistency checks of the format and content. Results can be seen directly on the repository.

bash jupyter-lab

Annotation guidelines

We use reStructured TExt using the utility Sphinx which provide several output formats. Currently we support XML and PDF.

To build this documentation locally, we recommend to create a virtual environment such as virtualenv or conda:

bash conda create -name guidelines conda activate guidelines conda install sphinx

Build HTML site

To build the documentation as a website:

sphinx-build -b html docs _build

Automatic build

Sphinx allows automatic build using sphinx-autobuild, which will automatically reload and update on a webservice spawned at-hoc. You can launch the automatic build using:

sphinx-autobuild docs build_

you can access the service by opening the browser at http://localhost:8000.

Build PDF

You can export this document as PDF using rst2pdf.

Even if you have conda, you should install the version provided by pipy:

pip install rst2pdf

Then you need to modify your config.py by adding the following information:

python extensions = ['rst2pdf.pdfbuilder'] pdf_documents = [('index', u'filename', u'Title', u'Author')]

and build using

sphinx-build -b pdf sourcedir builddir

and a file with the specified name will be created in builddir.

Make a new release

bash bump-my-version bump major|minor|patch

Licence

The dataset is licensed under CC BY 4.0 CC. The Bibliographic data refers to the original content.

The code is licences under Apache 2.0

Owner

Name: Luca Foppiano
Login: lfoppiano
Kind: user

Repositories: 100
Profile: https://github.com/lfoppiano

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this dataset, please cite it as below."
authors:
- family-names: "Foppiano"
  given-names: "Luca"
  orcid: "https://orcid.org/0000-0002-6114-6164"
- family-names: "Dieb"
  given-names: "Sae"
  orcid: "https://orcid.org/0000-0002-8111-2009"
- family-names: "Suzuki"
  given-names: "Akira"
  orcid: "https://orcid.org/0000-0002-8167-0414"
- family-names: "de Castro"
  given-names: "Pedro Baptista"
  orcid: "https://orcid.org/0000-0001-8673-2840"
- family-names: "Iwasaki"
  given-names: "Suguru"
  orcid: "https://orcid.org/0000-0002-8181-6137"
- family-names: "Izuki"
  given-names: "Azusa"
- family-names: "Esparza Echevarria"
  given-names: "Miren Garbine"
- family-names: "Meng"
  given-names: "Yang"
- family-names: "Terashima"
  given-names: "Kensei"
  orcid: "https://orcid.org/0000-0003-0375-3043"
- family-names: "Romary"
  given-names: "Laurent"
  orcid: "https://orcid.org/0000-0002-0756-0508"
- family-names: "Takano"
  given-names: "Yoshihiko"
  orcid: "https://orcid.org/0000-0002-1541-6928"
- family-names: "Ishii"
  given-names: "Masashi"
  orcid: "https://orcid.org/0000-0003-0357-2832"
title: "grobid-superconductors"
version: 2.0.4
url: "https://github.com/lfoppiano/grobid-superconductors"
preferred-citation:
  type: unpublished
  authors:
  - family-names: "Foppiano"
    given-names: "Luca"
    orcid: "https://orcid.org/0000-0002-6114-6164"
  - family-names: "de Castro"
    given-names: "Pedro Baptista"
    orcid: "https://orcid.org/0000-0001-8673-2840"
  - family-names: "Ortiz Suarez"
    given-names: "Pedro"
    orcid: "https://orcid.org/0000-0003-0343-8852"
  - family-names: "Terashima"
    given-names: "Kensei"
    orcid: "https://orcid.org/0000-0003-0375-3043"
  - family-names: "Takano"
    given-names: "Yoshihiko"
    orcid: "https://orcid.org/0000-0002-1541-6928"
  - family-names: "Ishii"
    given-names: "Masashi"
    orcid: "https://orcid.org/0000-0003-0357-2832"
  doi: "10.1080/27660400.2021.1918396"
  journal: "Science and Technology of Advanced Materials: Methods"
  month: 7
  start: 34
  end: 44
  title: "SuperMat: construction of a linked annotated dataset from superconductors- related publications"
  issue: 1
  volume: 3
  year: 2021

GitHub Events

Total

Watch event: 4

Last Year

Watch event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 73
Total pull requests: 8
Average time to close issues: about 10 hours
Average time to close pull requests: 23 minutes
Total issue authors: 2
Total pull request authors: 1
Average comments per issue: 0.01
Average comments per pull request: 0.0
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 4
Average time to close issues: N/A
Average time to close pull requests: 33 minutes
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

lfoppiano (50)
oriondollar (1)

Pull Request Authors

lfoppiano (5)

Top Labels

Issue Labels

question (39) documented (32) add-to-doc (7) phase-2 (2) obsolete (1)

Pull Request Labels

enhancement (1)

Packages

Total packages: 1
Total downloads:
- pypi 22 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 5
Total maintainers: 1

pypi.org: supermat

SuperMat (Superconductors Material) dataset is a manually **linked** **annotated** dataset of superconductors related materials and properties.

Homepage: https://supermat.readthedocs.io
Documentation: https://supermat.readthedocs.io/
License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Latest release: 3.0.0
published over 2 years ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 22 Last month

Rankings

Dependent packages count: 9.8%

Average: 38.8%

Dependent repos count: 67.8%

Maintainers (1)

lfoppiano