Skip to content

Reorganize config.tempalate (formerly config.analysis) #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
milenaveneziani merged 5 commits into from
Feb 10, 2017
Merged

Reorganize config.tempalate (formerly config.analysis) #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a849a66
Reorganize config.tempalate and update analysis
xylar Jan 27, 2017
1599b5f
Add example config files
xylar Feb 2, 2017
b9ffc94
Update readme to include run instructions
xylar Feb 2, 2017
16f2519
Add CI testing for checkGenerate
xylar Feb 3, 2017
682cf97
Added correct remap file in example config file for 240km mesh
milenaveneziani Feb 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# User defined config files
/config.analysis.*
/config.analysis_*
/config.*
!/config.template

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ You can easily install them via the conda command:
```
conda install -c scitools -c https://conda.anaconda.org/opengeostat numpy scipy matplotlib ipython notebook netCDF4 progressbar vtk cartopy xarray dask bottleneck pyevtk numexpr basemap
```

## Running the analysis
1. create a configuration file by copying and modifying `config.template` or one of the example files in `configs`
Copy link
Collaborator

@milenaveneziani milenaveneziani Feb 3, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we exclude the custom config files in gitignore? A quick google search revealed that we could have something like this in .gitignore:
/config.*
!/config.template

which basically means ignore all config.* but config.template.

2. run: `./run_analysis.py config.myrun`, where `config.myrun` is the config file you created
3. If you want to run a subset of the analysis, you can either modify the `generate` option under `[output]` in the config file or use the `--generate` flag on the command line. See `config.template` for more details.
263 changes: 0 additions & 263 deletions config.analysis
View file
Open in desktop

This file was deleted.

Loading