showyourwork.yml

# Enable rule caching on Zenodo?
cache_on_zenodo: true

# 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:
  #  - src/tex/orcid-ID.png


# Externally-hosted datasets, e.g. on Zenodo
datasets:
  10.5281/zenodo.5546676:
    destination: src/data
    contents:
      endo3_bbhpop-LIGO-T2100113-v12.hdf5:
  10.5281/zenodo.7843926:
    destination: src/data
    contents:
      analyses_PowerLawPeak.tar.gz:
        analyses:
          PowerLawPeak:
            o1o2o3_mass_c_iid_mag_iid_tilt_powerlaw_redshift_result.json:

# Custom file dependencies
dependencies:
  src/scripts/corner_plot.py:
    - src/data/gwisotropy_result.nc
    - src/static/dipole_skymap_j.png
    - src/static/dipole_skymap_n.png
  src/scripts/density_3d_plot.py:
    - src/data/gwisotropy_result.nc
  src/scripts/norm_plot.py:
    - src/data/gwisotropy_result.nc
  src/tex/gwisotropy.tex:
    - src/tex/output/macros.tex
  src/scripts/control_rates_plot.py:
    - src/data/gwisotropy_result.nc
    - src/data/control_rates_gwisotropy_result.nc

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

# 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: true
  # 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: true

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