Add SoftwareX citation (#31)

kip-hart · Oct 6, 2020 · 2d17d54 · 2d17d54
1 parent 13663c9
commit 2d17d54
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 12 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -12,6 +12,7 @@ Added
 '''''''
 - References within XML input files using the ``<include>`` tag.
 - Support for gmsh. (addresses `#16`_)
+- Citation to SoftwareX publication.
 
 Fixed
 '''''''

diff --git a/LICENSE.rst b/LICENSE.rst
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Georgia Tech Research Corporation
+Copyright (c) 2019-2020 Georgia Tech Research Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.rst b/README.rst
@@ -3,7 +3,9 @@ MicroStructPy - Microstructure Mesh Generation in Python
 
 |s-ci|
 |s-license|
-|s-doi|
+
+|s-doi1|
+|s-doi2|
 
 |l-github| `Repository <https://github.com/kip-hart/MicroStructPy>`_
 |l-rtd| `Documentation <https://docs.microstructpy.org>`_
@@ -134,15 +136,23 @@ Once built, the documentation will be in ``docs/build/``.
 Publications
 ------------
 
-If you use MicroStructPy in you work, please consider including this citation
+If you use MicroStructPy in you work, please consider including these citations
 in your bibliography:
 
 K. A. Hart and J. J. Rimoli, Generation of statistically representative
 microstructures with direct grain geomety control,
-*Computer Methods in Applied Mechanics and Engineering*,
-370 (2020), pp. 113242.
-(`BibTeX <https://github.com/kip-hart/MicroStructPy/raw/master/docs/publications/cmame2020.bib>`_)
-(`DOI <https://doi.org/10.1016/j.cma.2020.113242>`_)
+*Computer Methods in Applied Mechanics and Engineering*, 370 (2020), 113242.
+(`BibTeX <https://github.com/kip-hart/MicroStructPy/raw/master/docs/publications/cmame2020.bib>`__)
+(`DOI <https://doi.org/10.1016/j.cma.2020.113242>`__)
+
+K. A. Hart and J. J. Rimoli, MicroStructPy: A statistical microstructure mesh
+generator in Python, *SoftwareX*, 12 (2020), 100595.
+(`BibTeX <https://github.com/kip-hart/MicroStructPy/raw/master/docs/publications/swx2020.bib>`__)
+(`DOI <https://doi.org/10.1016/j.softx.2020.100595>`__)
+
+The news article `AE Doctoral Student Kenneth A. Hart Presents MicroStructPy to the World <https://www.ae.gatech.edu/news/2020/07/ae-doctoral-student-kenneth-hart-presents-microstructpy-world>`__,
+written by the School of Aerospace Engineering at Georgia Tech,
+describes MicroStructPy for a general audience.
 
 .. end-publications
 
@@ -189,6 +199,10 @@ advised by Prof. Julian Rimoli.
     :target: https://github.com/kip-hart/MicroStructPy/blob/master/LICENSE.rst
     :alt: License
 
-.. |s-doi| image:: https://img.shields.io/badge/DOI-10.1016%2Fj.cma.2020.113242-blue
+.. |s-doi1| image:: https://img.shields.io/badge/DOI-10.1016%2Fj.cma.2020.113242-blue
    :target: https://doi.org/10.1016/j.cma.2020.113242
-   :alt: DOI
+   :alt: CMAME DOI
+
+.. |s-doi2| image:: https://img.shields.io/badge/DOI-10.1016%2Fj.softx.2020.100595-blue
+   :target: https://doi.org/10.1016/j.softx.2020.100595
+   :alt: SoftwareX DOI
diff --git a/docs/publications/cmame2020.bib b/docs/publications/cmame2020.bib
@@ -3,7 +3,7 @@ @article{Hart2020
     title = {Generation of statistically representative microstructures with direct grain geomety control},
     journal = {Computer Methods in Applied Mechanics and Engineering},
     volume = {370},
-    pages = {113242},
+    artnum = {113242},
     year = {2020},
     issn = {0045-7825},
     doi = "https://doi.org/10.1016/j.cma.2020.113242",

diff --git a/docs/publications/swx2020.bib b/docs/publications/swx2020.bib
@@ -0,0 +1,13 @@
+@article{Hart2020swX,
+title = "MicroStructPy: A statistical microstructure mesh generator in Python",
+journal = "SoftwareX",
+volume = "12",
+pages = "100595",
+year = "2020",
+issn = "2352-7110",
+doi = "https://doi.org/10.1016/j.softx.2020.100595",
+url = "http://www.sciencedirect.com/science/article/pii/S2352711020303083",
+author = "Kenneth A. Hart and Julian J. Rimoli",
+keywords = "Microstructure, Mesh generation, Polycrystal, Laguerre tessellation",
+abstract = "MicroStructPy is a statistical microstructure mesh generator written in Python. This software package includes classes and methods to generate a mesh by (i) creating a list of grain seed geometries, (ii) packing them into a domain, (iii) performing a Laguerre tessellation of the seed geometries, and (iv) performing quality unstructured meshing. Results can be visualized and compared with the specified microstructural properties. MicroStructPy accurately reproduces 2D and 3D polycrystalline microstructures with arbitrary number of phases, volume fractions and distributions, each including the possibility of elongated grains. It can also generate meshes for amorphous phases and porous materials. Meshes are suitable for direct numerical simulation, a prevalent technique in computational mechanics of materials and geomechanics. The package contains extensive documentation, including guides and demonstrations to facilitate adoption for new users."
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -25,7 +25,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'MicroStructPy'
-copyright = '2020, Georgia Tech Research Corporation'
+copyright = '2019-2020, Georgia Tech Research Corporation'
 author = 'Kenneth Hart'
 
 # The short X.Y version

diff --git a/src/microstructpy/__init__.py b/src/microstructpy/__init__.py
@@ -4,4 +4,4 @@
 import microstructpy.seeding
 import microstructpy.verification
 
-__version__ = '1.3.5'
+__version__ = '1.4.0'