Skip to content

Commit

Permalink
#100 clarify how to specify stata executable (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
Quan authored Mar 6, 2018
1 parent a820bdf commit 4d9d4ac
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ If you try to build a directory without `config_user.yaml`, we'll copy a templat
#### What do I put in `config_user.yaml`?
There's no "default" for `config_user.yaml` because it depends on system specifications and user preferences. Three things we do recommend keeping in `config_user.yaml` are the name of your Stata executable, the location of a [SCons cache directory](http://scons.org/doc/2.0.1/HTML/scons-user/c4213.html), and the location of a release directory. These fields don't have to be specified if you're not using them, and we'll prompt you for their values at runtime if you've forgotten to specify them and they're necessary.
There's no "default" for `config_user.yaml` because it depends on system specifications and user preferences. Three things we do recommend keeping in `config_user.yaml` are the names of your executables, the location of a [SCons cache directory](http://scons.org/doc/2.0.1/HTML/scons-user/c4213.html), and the location of a release directory. These fields don't have to be specified if you're not using them, and we'll prompt you for their values at runtime if you've forgotten to specify them and they're necessary.
#### What is `config_global.yaml`?
Expand Down Expand Up @@ -130,7 +130,7 @@ python run.py ../paper_slides
#### What software can I use for data analysis?
We have custom builders for Python, R, Stata, and MATLAB. They all use the same syntax. You'll need to add the builder to the SCons environment by uncommenting its definition in the SConstruct. Also check that its executable has been added to your PATH.
We have custom builders for Python, R, Stata, and MATLAB. They all use the same syntax. You'll need to add the builder to the SCons environment by uncommenting its definition in the SConstruct. Also check that its executable has been added to your PATH and recorded in `config_user.yaml`.

See `analysis/source/prepare_data/` for sample scripts in each language. To run one of the sample scripts, uncomment its block in `analysis/source/prepare_data/SConscript` and its builder in `analysis/SConstruct`. Note that all sample scripts produce the same output, so only one block is allowed to run for each SCons build. If you uncomment the block for one software, you need to comment out the blocks for all others.

Expand Down
12 changes: 6 additions & 6 deletions config/config_user_template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@

# # Executable names
# executable_names:
# python: None
# r: None
# stata: None
# matlab: None
# lyx: none
# latex: None
# python: python
# r: Rscript
# stata: stata-mp
# matlab: matlab
# lyx: lyx
# latex: pdflatex

# # If True, check that application is installed/up-to-date before SCons run
# prereq_checks:
Expand Down

0 comments on commit 4d9d4ac

Please sign in to comment.