Skip to content
/ paper-template Public template

Template for a new paper repository with code, data, and manuscript

License

CC-BY-4.0, MIT licenses found

Licenses found

CC-BY-4.0
LICENSE-CC-BY.txt
MIT
LICENSE-MIT.txt
Notifications You must be signed in to change notification settings

compgeolab/paper-template

CompGeoLab Paper Template: This is a template used by the lab to generate research papers on GitHub with LaTeX and Jupyter notebooks.

To use it:

  1. Click on the "Use this template" button to create a new repository with the files from this template.
  2. Replace repository name in environment.yml and add other packages you may need.
  3. Add the information for your paper in this README.md.
  4. Create the relevant checklist issues using our provided templates.
  5. Delete these instructions.
  6. Do your science!

This works particularly well if your co-authors can send and review PRs. If not, connecting the repository to Overleaf is the most painless way we found to collaborate on the text (but it requires a paid subscription).


Paper title

by Author 1, Author 2, and Leonardo Uieda

This repository contains the data and source code used to produce the results presented in:

Reference of the paper and/or preprint.

Info
Version of record https://doi.org/JOURNAL_DOI
Open-access version on EarthArXiv https://doi.org/EARTHARXIV_DOI
Archive of this repository https://doi.org/FIGSHARE_ZENODO_DOI
Reproducing our results REPRODUCING.md

About

A little bit about this paper, how it came about, and what are the main contributions. Also include a summary figure or graphical abstract for this paper.

Abstract

The paper abstract. Paste it here once it's written.

License

All Python source code (including .py and .ipynb files) is made available under the MIT license. You can freely use and modify the code, without warranty, so long as you provide attribution to the authors. See LICENSE-MIT.txt for the full license text.

The manuscript text (including all LaTeX files), figures, and data/models produced as part of this research are available under the Creative Commons Attribution 4.0 License (CC-BY). See LICENSE-CC-BY.txt for the full license text.