showyourwork.yml

# Enable rule caching on Zenodo?
cache_on_zenodo: false

# Workflow graph (DAG) generation
dag:
  # Generate `dag.pdf` on each build?
  render: false
  # Graphviz layout engine
  engine: sfdp
  # Group files by type into plates?
  group_by_type: false
  # Custom graph attributes
  graph_attr:
    ranksep: "1"
    nodesep: "0.65"
  # Custom node attributes
  node_attr:
    shape: "box"
    penwidth: "2"
    width: "1"
  # Files and glob patterns to ignore
  ignore_files:
   - ms.synctex.gz
   - environment.yml
   - .showyourwork/*


# Externally-hosted datasets, e.g. on Zenodo
datasets:
  10.5281/zenodo.6949492:
    destination: src/data/finch_moore
    contents:
      dataset.zip:
        posterior_samples:
          GW150914:
            3W220221:
              posterior_samples.dat:
  10.5281/zenodo.7597043:
    destination: src/data
    contents:
      figure1.tar.gz:
        figure1:
          pyring_t0-bad_timestamps-bad_seglen-bad:
            result.nc:
          pyring_t0-good_timestamps-good_seglen-good:
            result.nc:
          ringdown_t0-bad_timestamps-good_seglen-bad:
            result.nc:
          ringdown_t0-bad_timestamps-good_seglen-good:
            result.nc:
          ringdown_t0-good_timestamps-good_seglen-good:
            result.nc:
      figure2.tar.gz:
        figure2:
          ds-o1-fake:
            summary_samples.hdf5:
          ds-o1-none:
            summary_samples.hdf5:
          gw150914:
            summary_samples.hdf5:

# Custom file dependencies
dependencies:
  src/scripts/figure1.py:
    - src/data/fig1_samples_dict.pkl
  src/scripts/figure2.py:
    - src/data/fm_t0_kde_grid.h5
    - src/data/figure2/figure2/ds-o1-fake/summary_samples.hdf5
    - src/data/figure2/figure2/ds-o1-none/summary_samples.hdf5
    - src/data/figure2/figure2/gw150914/summary_samples.hdf5
  # src/tex/ms.tex:
  #   - src/tex/stylesheet.tex

# Name of the `.tex` manuscript and corresponding `.pdf` article
ms_name: ms

# Optimize DAG by removing unnecessary jobs upstream of cache hits?
optimize_caching: true

# Overleaf sync settings
overleaf:
  # Overleaf project ID (blank = disabled)
  id: 
  # Perform sync on GitHub Actions?
  gh_actions_sync: true
  # List of files to push to Overleaf
  push:
    - src/tex/figures
    - src/tex/output
  # List of files to pull from Overleaf
  pull:
    - src/tex/ms.tex
    - src/tex/bib.bib

# Always require all input files to be present on disk for workflow to pass?
require_inputs: true

# Allow cacheable rules to run on GitHub Actions?
run_cache_rules_on_ci: false

# Mapping of script file extensions to instructions for executing them
scripts:
  py: python {script}

# Display of the `showyourwork` stamp on first page
stamp:
  # Show the stamp?
  enabled: false
  # Stamp angle in degrees
  angle: -20.0
  # Stamp size in inches
  size: 0.75
  # Horizontal position in inches from right edge of paper
  xpos: 0.50
  # Vertical position in inches from top edge of paper
  ypos: 0.50
  # Display of the repo URL in the stamp
  url:
    # Show the URL?
    enabled: true
    # Maximum URL length to display
    maxlen: 40

# Enable SyncTeX?
synctex: True

# Command-line options to be passed to tectonic when building the manuscript
tectonic_args: []

# Enable verbose output?
verbose: false

# Version of `showyourwork` used to create this workflow
version: 0.4.1