Using the repository template

Pre-requisites:

• Windows cmd.exe, Mac OS X bash, or Linux bash.
• Python 2.X (add to PATH)
• Stata MP (add to PATH)
• R (add to PATH)
• Lyx (add to PATH)
• SCons (Note that version 2.4.0 or later is best if using the cache).
  • More information about SCons can be found here.
• git-lfs
• gslab_tools version 3.0.3 or later
• GSLab-modified Metropolis beamer theme
• YAML-related packages/modules:
  • Stata ado file: yaml
  • Python module: PyYAML
  • R package: yaml

The easiest way to install some of the applications above is to use Homebrew on Mac OS and Linuxbrew on Linux, as they will set up the PATH variable for you, e.g., brew install scons.

To run:

• The entire directory:
  • In the root directory, type scons in the command line. This should run everything that is flagged as being modified or with dependencies that have been modified.
• A single directory of targets:
  • scons build/data will re-build the build/data folder if it is out of sync, without rebuilding other files.
• A single target file:
  • scons build/paper/paper.pdf will re-run only the code needed to update build/paper/paper.pdf without rebuilding other files.

See here for directions on making a 'release'.

Copy the template:

In order to create a new repository using this template, either

• First, either:
  • Fork this repository
  • Create an empty repository in GitHub and clone it locally. Copy the contents of this template into the empty repository. Make sure to exclude the .git folder, but include the .gitattributes and .gitignore files. Re-run the entire directory using Scons. Commit and push to the new repository.
• Setup a user-config.yaml in the root of the directory (note that this file should not be versioned):
  • MacOS or Linux minimal working example

  stata_flavor: statamp
  cache: /Users/leviboxell/Google Drive/cache/template
  

  • Windows 10 minimal working example (note the quotation marks)

  stata_flavor: "%STATAEXE%"
  cache: C:\Users\Levi Boxell\Google Drive\cache\template
  

License

The MIT License (MIT)

Copyright (c) 2016 Matthew Gentzkow, Jesse Shapiro

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.