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.

Preparing a Compatible Replication Package

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

Use a single software application per step

Each step of a SIVACOR submission only supports a single software application (Stata, R, MATLAB/Dynare or Julia — see Available Software). For each such step, you need a separate controller script, and configure separate steps, which you chain together in a highly simplified workflow system at submission, see instructions in Step 2. Your package should include the complete code for multiple applications.

Do not include any data that you are not allowed to upload to third-party systems

As a reminder, do not include data that you are not allowed to process on SIVACOR.

Excluding files from final package

Identify the files that you cannot publish, due to legal, ethical, or practical reasons. Prepare the .sivacorignore (note the leading dot!) file. It must be at the root of your project. This will be logged as part of the TRO, so it will be clear which files were removed.

Your replication package should be portable.

Code must run without manual intervention, use a single controller script (e.g., main.do or master.R) per step, and omit hard-coded absolute paths. File and directory paths are case-sensitive, and should use OS-neutral path separators (/, not \).

All dependencies must either be included or installed automatically.

If your code uses libraries or packages, you must ensure that they are installed automatically (for Stata, we suggest you include them). We strongly encourage packages that use “environments”, and packages to manage dependencies.

Package fits on the SIVACOR workers

You have verified that the replication package fits within the resource constraints of SIVACOR. A run is stopped if the worker runs out of disk space, see the FAQ.

Prepare a ZIP or tar.gz file

Your replication package must be a single ZIP file or tar.gz file.

The next step is to upload your package to SIVACOR.

ℹ️ FAQ

See the FAQ.

Footnotes
  1. groundhog is another option for managing R package dependencies. However, on Linux, it always recompiles from source, which can take a very long time, and may fail, depending on the system libraries required on the rocker environments used here.