Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor joss paper fixes #69

Merged
merged 2 commits into from
Jun 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions reports/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,22 @@ @misc{kipfSemisupervisedClassificationGraph2016
keywords = {FOS: Computer and information sciences,Machine Learning (cs.LG),Machine Learning (stat.ML)}
}

@article{ongPythonMaterialsGenomics2013,
title = {Python {{Materials Genomics}} (Pymatgen): {{A}} Robust, Open-Source Python Library for Materials Analysis},
shorttitle = {Python {{Materials Genomics}} (Pymatgen)},
author = {Ong, Shyue Ping and Richards, William Davidson and Jain, Anubhav and Hautier, Geoffroy and Kocher, Michael and Cholia, Shreyas and Gunter, Dan and Chevrier, Vincent L. and Persson, Kristin A. and Ceder, Gerbrand},
year = {2013},
month = feb,
journal = {Computational Materials Science},
volume = {68},
pages = {314--319},
issn = {09270256},
doi = {10.1016/j.commatsci.2012.10.028},
abstract = {We present the Python Materials Genomics (pymatgen) library, a robust, open-source Python library for materials analysis. A key enabler in high-throughput computational materials science efforts is a robust set of software tools to perform initial setup for the calculations (e.g., generation of structures and necessary input files) and post-calculation analysis to derive useful material properties from raw calculated data. The pymatgen library aims to meet these needs by (1) defining core Python objects for materials data representation, (2) providing a well-tested set of structure and thermodynamic analyses relevant to many applications, and (3) establishing an open platform for researchers to collaboratively develop sophisticated analyses of materials data obtained both from first principles calculations and experiments. The pymatgen library also provides convenient tools to obtain useful materials data via the Materials Project's REpresentational State Transfer (REST) Application Programming Interface (API). As an example, using pymatgen's interface to the Materials Project's RESTful API and phasediagram package, we demonstrate how the phase and electrochemical stability of a recently synthesized material, Li4SnS4, can be analyzed using a minimum of computing resources. We find that Li4SnS4 is a stable phase in the Li\textendash Sn\textendash S phase diagram (consistent with the fact that it can be synthesized), but the narrow range of lithium chemical potentials for which it is predicted to be stable would suggest that it is not intrinsically stable against typical electrodes used in lithium-ion batteries.},
langid = {english},
file = {C\:\\Users\\sterg\\Zotero\\storage\\GUGQ4GNV\\Ong et al. - 2013 - Python Materials Genomics (pymatgen) A robust, op.pdf}
}

@misc{Pythonista2021,
title = {Pythonista},
year = {2021},
Expand Down
24 changes: 12 additions & 12 deletions reports/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ authors:
affiliations:
- name: Materials Science & Engineering, University of Utah, Salt Lake City, USA
index: 1
date: 6 July 2022
date: 7 June 2022
bibliography: paper.bib

# # Optional fields if submitting to a AAS journal too, see this blog post:
Expand Down Expand Up @@ -85,19 +85,19 @@ be run without error.
"[Pythonistas](https://en.wiktionary.org/wiki/Pythonista)" and entry-level coders alike.
`xtal2png` provides a straightforward Python application programming interface (API) and
command line interface (CLI). `xtal2png` relies on `pymatgen.core.structure.Structure`
objects for representing crystal structures and also supports reading crystallographic
information files (CIFs) from directories. `xtal2png` encodes crystallographic
information related to the unit cell, crystallographic symmetry, and atomic elements and
coordinates which are each scaled individually according to the information type. An
upscaled version of the PNG image and a legend of the representation are given in
\autoref{fig:example-and-legend}. Due to the encoding of numerical values as grayscale
PNG images (allowable values are integers between 0 and 255), a small round-off error is
present during a single round of encoding and decoding. An example comparing an original
vs. decoded structure is given in \autoref{fig:original-decoded}.
[@ongPythonMaterialsGenomics2013] objects for representing crystal structures and also
supports reading crystallographic information files (CIFs) from directories. `xtal2png`
encodes crystallographic information related to the unit cell, crystallographic
symmetry, and atomic elements and coordinates which are each scaled individually
according to the information type. An upscaled version of the PNG image and a legend of
the representation are given in \autoref{fig:example-and-legend}. Due to the encoding of
numerical values as grayscale PNG images (allowable values are integers between 0 and
255), a small round-off error is present during a single round of encoding and decoding.
An example comparing an original vs. decoded structure is given in
\autoref{fig:original-decoded}.

![(a) Original and (b) `xtal2png` decoded visualizations of
[`mp-560471`](https://materialsproject.org/materials/mp-560471/) / $𝑍𝑛_2 𝐵_2 𝑃𝑏
𝑂_6$. Images were generated via [`pymatviz`](https://github.com/janosh/pymatviz) [@riebesellPymatviz2022] \label{fig:original-decoded}](figures/original-decoded.png){ width=50% }
[`mp-560471`](https://materialsproject.org/materials/mp-560471/) / $𝑍𝑛_2𝐵_2𝑃𝑏𝑂_6$. Images were generated via [`pymatviz`](https://github.com/janosh/pymatviz) [@riebesellPymatviz2022]. \label{fig:original-decoded}](figures/original-decoded.png){ width=50% }

The significance of the representation lies in being able to directly use the PNG
representation with image-based models which often do not directly support custom
Expand Down