Initial commit

.github/workflows/draft.yml

@@ -0,0 +1,19 @@
+name: Create Preview Draft from PR
+on:
+  pull_request:
+    branches: ['main']
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  draft:
+    uses: curvenote/actions/.github/workflows/draft.yml@v1
+    with:
+      id-pattern-regex: '^ubcgif-(?:[a-zA-Z0-9-_]{3,40})$'
+      venue: appliedgeophysics
+      collection: publications
+      kind: article
+      path: paper
+    secrets:
+      CURVENOTE: ${{ secrets.CURVENOTE_TOKEN }}
+      GITHUB: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/submit.yml

@@ -0,0 +1,18 @@
+name: Create Submission from Main
+on:
+  push:
+    branches: ['main']
+permissions:
+  contents: write
+jobs:
+  submit:
+    uses: curvenote/actions/.github/workflows/submit.yml@v1
+    with:
+      id-pattern-regex: '^ubcgif-(?:[a-zA-Z0-9-_]{3,40})$'
+      venue: appliedgeophysics
+      collection: publications
+      kind: article
+      path: paper
+    secrets:
+      CURVENOTE: ${{ secrets.CURVENOTE_TOKEN }}
+      GITHUB: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,11 @@
+_build
+
+*.log
+*.fls
+*.out
+*.blg
+*.bbl
+*.aux
+*.synctex.gz
+*.fdb_latexmk
+*.DS_Store

README.md

@@ -0,0 +1,75 @@
+# Template repository for papers by the GIF group
+
+Please use this repository as a template for papers
+
+## Repository name
+
+The naming convention should follow 
+
+```
+year-authors-journal-short-title
+```
+
+As an example for two authors: 
+```
+2023-heagy-oldenburg-gji-casing-permeability
+```
+
+if there are more than 2 authors, you can use `etal` to indicate multiple authors, e.g. 
+```
+2024-heagy-etal-tle-future-of-applied-geophysics
+```
+
+## Contents
+
+The paper should be put in a `paper` folder. You can put the original latex there. The published pdf from the journal should also be included here. 
+
+Please also include a `thumbnail.png`. This should be a high-impact figure from the paper. 
+
+## MyST.md
+
+The key file that you will need to update is the `myst.yml` file which is located in the `paper` folder. You will need to fill out the fields that are currently commented out. 
+
+The project id should follow the pattern `ubcgif-YEAR-AUTHORS-JOURNAL`, e.g. `ubcgif-2023-heagy-oldenburg-gji` or `2024-heagy-etal-tle`
+
+Descriptions of the fields is available here: https://mystmd.org/guide/frontmatter#available-frontmatter-fields
+
+## Previewing the site
+
+You can preview the build using MyST. Please have MyST installed ([instructions](https://mystmd.org/guide/installing)). From the `paper` folder, you can then run 
+
+```
+myst start
+```
+
+and a preview will launch, usually from `http://localhost:3000`
+
+Also, whenever you create a pull-request to the repo, curvenote will build you a preview 🚀. A link will be added to the comment thread that looks something like this 
+
+![image](https://github.com/ubcgif/template-repository-paper/assets/6361812/b7a144c5-8458-474b-98c4-9e5890ac859e)
+
+
+## README 
+Please use the following as a template for the 
+```
+# Template repository for papers
+
+_Authors_
+
+[https://doi.org/XXX](https://doi.org/XXX)
+
+![thumbnail](./paper/thumbnail.png)
+
+## Summary
+
+Summary of the paper here (pulled from abstract/summary of paper) 
+
+## Citation
+
+Please include the formatted citation along with bibtex for the reference
+
+```
+
+## Examples
+- https://github.com/ubcgif/2023-heagy-oldenburg-gji-casing-permeability
+- https://github.com/ubcgif/2024-heagy-etal-tle-future-of-applied-geophysics

paper/myst.yml

@@ -0,0 +1,49 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  # id: ubcgif-YEAR-AUTHORS-JOURNAL
+  # title: TITLE OF PAPER
+  # description: SHORT DESCRIPTION HERE
+  authors:
+    # - name: AUTHOR 1
+    #   email: EMAIL
+    #   corresponding: true
+    #   orcid: ORCID
+    #   affiliation:
+    #     id: ubc
+    #     name: Geophysical Inversion Facility, University of British Columbia, Vancouver, British Columbia
+    # - name: Lindsey J. Heagy
+    #   email: [email protected]
+    #   corresponding: true
+    #   orcid: 0000-0002-1551-5926
+    #   affiliation: ubc
+  # doi: DOI
+  # arxiv: ARXIV
+  # github: GITHUB-URL
+  # date: YYYY/MM/DD # date of publication
+  # license: CC-BY-4.0  # uncomment this and the line below if open access
+  # open_access: true
+  venue:
+    # title: JOURNAL NAME
+    # url: JOURNAL URL
+  history:
+    # received: YYYY/MM/DD
+    # accepted: YYYY/MM/DD
+    # published: YYYY/MM/DD
+  keywords:
+    # - KEYWORD 1
+    # - KEYWORD 2
+    # - KEYWORD 3
+    # - KEYWORD 4
+  abbreviations:
+    # CSEM: controlled source electromagnetics
+    # EM: electromagnetics
+  thumbnail: thumbnail.png
+  numbering:
+    headings: true
+site:
+  template: article-theme
+  actions:
+    - title: pdf
+      # url: NAME-OF-PDF.pdf
+      static: true