Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Tutorial: Removing Data with .sivacorignore

Authors
Affiliations
Cornell University
National Center for Supercomputing Applications
University of Illinois at Urbana-Champaign

The .sivacorignore file follows the same pattern rules as .gitignore, so you can use glob patterns, negations, and directory-specific rules.

A simple example

For example, to exclude a data/raw/ directory and all .tmp files, the .sivacorignore file would look like this:

data/raw/
*.tmp

Your replication package then should look somewhat like this:

data/raw/
  file1.csv
code/
  main.R
  ...
.sivacorignore

before it is run, and might look like this

code/
  main.R
output/
  figure.png
  ...
.sivacorignore

after the run (note removal of data/raw).

Removing data that are obtained via API

In general, you should provide a copy of the data that you obtain via API, as the API query might yield different results over time. However, if you cannot, then .sivacorignore can be used to exclude the API-obtained data from your replication package.