include CMAME paper citation in documentation (#24)

kip-hart · Jun 25, 2020 · f44991b · f44991b
1 parent 1fd4a14
commit f44991b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -127,13 +127,30 @@ top-level directory of the MicroStructPy repository::
 
 Once built, the documentation will be in ``docs/build/``.
 
+.. begin-publications
+
+Publications
+------------
+
+If you use MicroStructPy in you work, please consider including this citation
+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*,
+in press.
+(`BibTex <https://github.com/kip-hart/MicroStructPy/raw/master/docs/publications/cmame2020.bib>`_)
+
+.. end-publications
+
 Contributing
 ------------
 
 Contributions to the project are welcome.
 Please use the GitHub pull request and issue submission features.
 See the `Contributing Guidelines`_ for more details.
 
+
 License and Attributions
 ------------------------
 

diff --git a/docs/publications/cmame2020.bib b/docs/publications/cmame2020.bib
@@ -0,0 +1,6 @@
+@article{Hart2020,
+    author = {Hart, Kenneth A and Rimoli, Julian J},
+    title = {Generation of statistically representative microstructures with direct grain geomety control},
+    journal = {Computer Methods in Applied Mechanics and Engineering},
+    year = {in press},
+}
diff --git a/docs/source/welcome.rst b/docs/source/welcome.rst
@@ -107,6 +107,11 @@ The same results can be produced using this script:
         plt.show()
 
 
+.. include:: ../../README.rst
+    :start-after: begin-publications
+    :end-before: end-publications
+
+
 License and Attribution
 -----------------------