Introduction#
Introduce the code, methods, and uses.
Referencing My Project#
Include instructions on how to cite your code. Include
Citation to software
Citation to science and method publications
Data Availability#
Explain what data should be made available when publishing. Mention preferred formats and repositories.
CIG maintains a Community on Zenodo. Search for the Computational Infrastructure for Geodynamics to associate you project with the geodynamics community.
Acknowledgments#
Acknowledge the funders of your project.
Thanks to the ASPECT, Rayleigh, and GDMATE projects for providing example documentation to draw from.
Computational Infrastructure for Geodynamics (CIG) is supported by the National Science Foundation awards NSF-0949446, NSF-1550901, and NSF-2149126.
Miscellaneous formatting#
Tip boxes#
You can add tip boxes to highlight important information.
Important
Add Important messages here.
Warning
Add warning here.
Error
Add error here.
Information
Add Information here.
Figures#
Do not foget to add some figures (Fig. 1) to explain and visualize concepts.
References#
References can be included inline Laureate [9999], Oscar [9999]. Only cited references found in references.bib
will be displayed in the References section.