Skip to content

Commit f8ea92d

Browse files
committed
Merge branch 'master' into release
2 parents 5d6531f + 286fe99 commit f8ea92d

13 files changed

+783
-49
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,6 @@ install:
6161
- pip install -e .
6262
script:
6363
- pip install pytest pytest-cov coveralls
64-
- pip install jupyter pandas plotnine holoviews terrainbento tqdm
64+
- pip install jupyter pandas plotnine holoviews terrainbento tqdm rasterio
6565
- pytest umami tests/ --doctest-modules --cov=umami --cov-report=xml:$(pwd)/coverage.xml -vvv
6666
after_success: coveralls

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Coverage Status](https://coveralls.io/repos/github/TerrainBento/umami/badge.svg?branch=master)](https://coveralls.io/github/TerrainBento/umami?branch=master)
55
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/umami/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)
66
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TerrainBento/umami/master?filepath=notebooks%2FWelcome.ipynb)
7+
[![status](https://joss.theoj.org/papers/1dea51d02def0ff3ef5108eb2a7af3a4/status.svg)](https://joss.theoj.org/papers/1dea51d02def0ff3ef5108eb2a7af3a4)
78

89
# What is it?
910

@@ -91,18 +92,26 @@ Documentation is housed on [ReadTheDocs](https://umami.readthedocs.io).
9192

9293
Umami uses Github Issue as a single point of contact for users and developers.
9394
To ask a question, report a bug, make a feature request, or to get in touch for
94-
any reason, please make
95-
[an Issue](https://github.com/TerrainBento/umami/issues).
95+
any reason, please make [an Issue](https://github.com/TerrainBento/umami/issues).
9696

9797
# Contribute to umami
9898

99-
All contributions are welcome.
99+
All contributions are welcome and appreciated. Feel free to:
100+
101+
- Make [an issue](https://github.com/TerrainBento/umami/issues) to ask a
102+
question. Your question will help others in the future.
103+
- Make [an issue](https://github.com/TerrainBento/umami/issues) to report a
104+
bug or a potential improvement. We will work to fix it. If you have an idea
105+
about how to fix it, please feel free to propose it, or make a Pull Request.
106+
- [Fork the repository](https://help.github.com/en/articles/fork-a-repo), make
107+
changes to the source code on a
108+
[development branch](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow),
109+
and submit a Pull Request to have your changes brought into the umami
110+
repository. **No contribution to the code base or documentation is too small.**
100111

101112
Contributors and maintainers to this project are are expected to abide the [Contributor Code of Conduct](https://github.com/TerrainBento/umami/blob/master/CODE_OF_CONDUCT.md).
102113

103114
# Cite umami
115+
[![status](https://joss.theoj.org/papers/1dea51d02def0ff3ef5108eb2a7af3a4/status.svg)](https://joss.theoj.org/papers/1dea51d02def0ff3ef5108eb2a7af3a4)
104116

105-
If you use umami in your research, please cite it.
106-
107-
A Journal of Open Source Software submission is planned. When it is finalized,
108-
a link and citation will be found here.
117+
Umami is described by a Journal of Open Source Software paper. If you use umami in your research, please cite it.

appveyor.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ install:
2929
- cmd: conda config --set always_yes yes
3030
- cmd: pip install pytest
3131
- cmd: pip install jupyter pandas plotnine holoviews terrainbento tqdm
32+
- cmd: conda install rasterio -c conda-forge
33+
- cmd: conda install landlab -c conda-forge
3234
- cmd: conda info
3335
- cmd: conda list
3436

binder/postBuild

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ conda install pandas
99
conda install plotnine>=0.6.0
1010
conda install terrainbento>=1.10.1
1111
conda install tqdm
12+
conda install rasterio
1213

1314
python setup.py install

environment-dev.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ dependencies:
2020
- tqdm
2121
- plotnine>=0.6.0
2222
- terrainbento>=1.1
23+
- gdal
24+
- rasterio

joss/paper.bib

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,41 @@
11
@Article{hobley2017creative,
22
AUTHOR = {Hobley, D. E. J. and Adams, J. M. and Nudurupati, S. S. and Hutton, E. W. H. and Gasparini, N. M. and Istanbulluoglu, E. and Tucker, G. E.},
3-
TITLE = {Creative computing with Landlab: an open-source toolkit for building, coupling, and exploring two-dimensional numerical models of Earth-surface dynamics},
3+
TITLE = {{Creative computing with Landlab: an open-source toolkit for building, coupling, and exploring two-dimensional numerical models of Earth-surface dynamics}},
44
JOURNAL = {Earth Surface Dynamics},
55
VOLUME = {5},
66
YEAR = {2017},
77
NUMBER = {1},
88
PAGES = {21--46},
9-
URL = {https://www.earth-surf-dynam.net/5/21/2017/},
109
DOI = {10.5194/esurf-5-21-2017}
1110
}
1211

1312
@Article{barnhart2019terrain,
1413
AUTHOR = {Barnhart, K. R. and Glade, R. C. and Shobe, C. M. and Tucker, G. E.},
15-
TITLE = {Terrainbento 1.0: a Python package for multi-model analysis in long-term drainage basin evolution},
14+
TITLE = {{Terrainbento 1.0: a Python package for multi-model analysis in long-term drainage basin evolution}},
1615
JOURNAL = {Geoscientific Model Development},
1716
VOLUME = {12},
1817
YEAR = {2019},
1918
NUMBER = {4},
2019
PAGES = {1267--1297},
21-
URL = {https://www.geosci-model-dev.net/12/1267/2019/},
2220
DOI = {10.5194/gmd-12-1267-2019}
2321
}
2422

2523
@article{adams2019dakota,
26-
author = {Adams, Brian M and Eldred, Michael S and Geraci, Gianluca and Hooper, Russell W and Jakeman, John D and Maupin, Kathryn A and Monschk, Jason A and Rushdi, Ahmad A and Stephens, J Adam and Swiler, Laura P and Wildey, Timothy M and Bohnhoff, William J and Dalbey, Keith R and Ebeida, Mohamed S and Eddy, John P and Hough, Patricia D and Khalil, Mohammad and Hu, Kenneth T and Ridgway, Elliott M and Vigil, Dena M and Winokur, Justin G},
24+
author = {Adams, B. M. and Eldred, S. and Geraci, G. and Hooper, R. W. and Jakeman, J. D. and Maupin, K. A. and Monschk, J. A. and Rushdi, A. A. and Stephens, J. A. and Swiler, L. P. and Wildey, T. M. and Bohnhoff, W. J. and Dalbey, K. R. and Ebeida, M. S. and Eddy, J. P. and Hough, P. D. and Khalil, M. and Hu, K. T. and Ridgway, E. M. and Vigil, D. M. and Winokur, J. G.},
2725
title = {{Dakota, A Multilevel Parallel Object-Oriented Framework for Design Optimization, Parameter Estimation, Uncertainty Quantification, and Sensitivity Analysis: Version 6.10 User{\textquoteright}s Manual}},
28-
journal = {Sandia National Laboratories, Tech. Rep. SAND2014-4633},
26+
journal = {{Sandia National Laboratories, Tech. Rep. SAND2014-4633}},
2927
year = {2019}
3028
}
3129

3230

3331
@Article{forte2019tak,
3432
AUTHOR = {Forte, A. M. and Whipple, K. X.},
35-
TITLE = {Short communication: The Topographic Analysis Kit (TAK) for TopoToolbox},
33+
TITLE = {{Short communication: The Topographic Analysis Kit (TAK) for TopoToolbox}},
3634
JOURNAL = {Earth Surface Dynamics},
3735
VOLUME = {7},
3836
YEAR = {2019},
3937
NUMBER = {1},
4038
PAGES = {87--95},
41-
URL = {https://www.earth-surf-dynam.net/7/87/2019/},
4239
DOI = {10.5194/esurf-7-87-2019}
4340
}
4441

@@ -50,7 +47,6 @@ @Article{club2017geomorphometric
5047
YEAR = {2017},
5148
NUMBER = {3},
5249
PAGES = {369--385},
53-
URL = {https://www.earth-surf-dynam.net/5/369/2017/},
5450
DOI = {10.5194/esurf-5-369-2017}
5551
}
5652

@@ -61,42 +57,38 @@ @article{mudd2014statistical
6157
volume = {119},
6258
number = {2},
6359
pages = {138-152},
64-
keywords = {bedrock channels, topographic analysis, landscape evolution},
6560
doi = {10.1002/2013JF002981},
66-
url = {https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1002/2013JF002981},
6761
year = {2014}
6862
}
6963

7064

7165
@Article{schwanghart2014topo,
7266
AUTHOR = {Schwanghart, W. and Scherler, D.},
73-
TITLE = {Short Communication: TopoToolbox 2 - a MATLAB-based software for topographic analysis and modeling in Earth surface sciences},
67+
TITLE = {{Short Communication: TopoToolbox 2 - a MATLAB-based software for topographic analysis and modeling in Earth surface sciences}},
7468
JOURNAL = {Earth Surface Dynamics},
7569
VOLUME = {2},
7670
YEAR = {2014},
7771
NUMBER = {1},
7872
PAGES = {1--7},
79-
URL = {https://www.earth-surf-dynam.net/2/1/2014/},
8073
DOI = {10.5194/esurf-2-1-2014}
8174
}
8275

8376

8477
@article{schwanghart2010topo,
85-
author = "Schwanghart, W. and Kuhn, N. J.",
86-
title = "TopoToolbox: A set of Matlab functions for topographic analysis",
87-
journal = "Environmental Modelling & Software",
88-
volume = "25",
89-
number = "6",
90-
pages = "770 - 781",
91-
year = "2010",
92-
issn = "1364-8152",
93-
doi = "https://doi.org/10.1016/j.envsoft.2009.12.002",
94-
url = "http://www.sciencedirect.com/science/article/pii/S1364815209003053"
78+
author = {Schwanghart, W. and Kuhn, N. J.},
79+
title = {{TopoToolbox: A set of Matlab functions for topographic analysis}},
80+
journal = {{Environmental Modelling \& Software}},
81+
volume = {25},
82+
number = {6},
83+
pages = {770 - 781},
84+
year = {2010},
85+
issn = {1364-8152},
86+
doi = {https://doi.org/10.1016/j.envsoft.2009.12.002}
9587
}
9688

9789
@Article{ perron2013integral,
9890
author = {Perron, J Taylor and Royden, Leigh},
99-
journal = {Earth Surface Processes and Landforms},
91+
journal = {{Earth Surface Processes and Landforms}},
10092
number = {6},
10193
pages = {570--576},
10294
publisher = {Wiley Online Library},

notebooks/DiscretizedMisfit.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Part 4: Application using the Discretized Misfit calculation\n",
7+
"# Part 5: Application using the Discretized Misfit calculation\n",
88
"\n",
99
"\n",
10-
"By now, you should have looked through [Part 1](IntroductionToMetric.ipynb) and [Part 2](IntroductionToResidual.ipynb) of the introductory notebook series. These introduced the umami `Metric` and `Residual` classes. You should have also worked through [Part 3](ExampleApplication.ipynb), which provides an example application of umami. \n",
10+
"By now, you should have looked through [Part 1](IntroductionToMetric.ipynb), [Part 2](IntroductionToResidual.ipynb) of the introductory notebook series, and [Part 3](OtherIO_options.ipynb) of the introductory notebook series. These introduced the umami `Metric` and `Residual` classes. You should have also worked through [Part 4](ExampleApplication.ipynb), which provides an example application of umami. \n",
1111
"\n",
1212
"## Scope\n",
1313
"\n",
14-
"Similar to [Part 3](ExampleApplication.ipynb), this application will use umami alongside the [terrainbento](https://terrainbento.readthedocs.io/en/latest/) package. As in the prior example, we will define a \"synthetic truth\" model evaluation with a specific set of input parameters, and then do a grid search letting some of those parameters vary. In this way we will explore which statistics for model-data comparison do best at identifying the \"true\" parameters. \n",
14+
"Similar to [Part 4](ExampleApplication.ipynb), this application will use umami alongside the [terrainbento](https://terrainbento.readthedocs.io/en/latest/) package. As in the prior example, we will define a \"synthetic truth\" model evaluation with a specific set of input parameters, and then do a grid search letting some of those parameters vary. In this way we will explore which statistics for model-data comparison do best at identifying the \"true\" parameters. \n",
1515
"\n",
1616
"This application focuses on the least intuitive of the umami calculations: the [`discretized_misfit`](https://umami.readthedocs.io/en/latest/umami.calculations.residual.discretized_misfit.html). \n",
1717
"\n",
@@ -477,7 +477,7 @@
477477
"name": "python",
478478
"nbconvert_exporter": "python",
479479
"pygments_lexer": "ipython3",
480-
"version": "3.7.3"
480+
"version": "3.7.4"
481481
}
482482
},
483483
"nbformat": 4,

notebooks/ExampleApplication.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Part 3: Example application\n",
7+
"# Part 4: Example application\n",
88
"\n",
9-
"By now, you should have looked through [Part 1](IntroductionToMetric.ipynb) and [Part 2](IntroductionToResidual.ipynb) of the introductory notebook series. These introduced the umami `Metric` and `Residual` classes. \n",
9+
"By now, you should have looked through [Part 1](IntroductionToMetric.ipynb), [Part 2](IntroductionToResidual.ipynb) of the introductory notebook series, and [Part 3](OtherIO_options.ipynb). These introduced the umami `Metric` and `Residual` classes. \n",
1010
"\n",
1111
"## Scope\n",
1212
"\n",
@@ -402,7 +402,7 @@
402402
"source": [
403403
"# Next steps\n",
404404
"\n",
405-
"The next step is the final notebook in the four part introductory series: [Part 4: Application using the Discretized Misfit calculation](DiscretizedMisfit.ipynb)."
405+
"The next step is the final notebook in the four part introductory series: [Part 5: Application using the Discretized Misfit calculation](DiscretizedMisfit.ipynb)."
406406
]
407407
},
408408
{
@@ -429,7 +429,7 @@
429429
"name": "python",
430430
"nbconvert_exporter": "python",
431431
"pygments_lexer": "ipython3",
432-
"version": "3.7.3"
432+
"version": "3.7.4"
433433
}
434434
},
435435
"nbformat": 4,

notebooks/IntroductionToMetric.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Part 1: Introduction to Umami and the `Metric` Class\n",
88
"\n",
9-
"Umami is a package for calculating metrics for use with for Earth surface dynamics models. This notebook is the first half of a two-part introduction to using umami.\n",
9+
"Umami is a package for calculating metrics for use with for Earth surface dynamics models. This notebook is the first part of a three-part introduction to using umami.\n",
1010
"\n",
1111
"Umami was designed to work well with the [terrainbento](https://terrainbento.readthedocs.io/en/latest/) model package, as well as other models built using the [Landlab Toolkit](https://github.com/landlab/landlab). \n",
1212
"\n",
@@ -361,7 +361,7 @@
361361
"name": "python",
362362
"nbconvert_exporter": "python",
363363
"pygments_lexer": "ipython3",
364-
"version": "3.7.3"
364+
"version": "3.7.4"
365365
}
366366
},
367367
"nbformat": 4,

notebooks/IntroductionToResidual.ipynb

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Part 2: Introduction to Umami and the `Residual` Class\n",
88
"\n",
9-
"Umami is a package for calculating metrics for use with for Earth surface dynamics models. This notebook is the second half of a two-part introduction to using umami.\n",
9+
"Umami is a package for calculating metrics for use with for Earth surface dynamics models. This notebook is the second notebook in a three-part introduction to using umami.\n",
1010
"\n",
1111
"## Scope of this tutorial\n",
1212
"\n",
@@ -278,8 +278,15 @@
278278
"source": [
279279
"# Next steps\n",
280280
"\n",
281-
"Now that you have a sense for how the `Metric` and `Residual` classes are used, try the next notebook: [Part 3: Example application](ExampleApplication.ipynb)."
281+
"Now that you have a sense for how the `Metric` and `Residual` classes are used, try the next notebook: [Part 3: Other IO options (using umami without Landlab or terrainbento)](OtherIO_options.ipynb)."
282282
]
283+
},
284+
{
285+
"cell_type": "code",
286+
"execution_count": null,
287+
"metadata": {},
288+
"outputs": [],
289+
"source": []
283290
}
284291
],
285292
"metadata": {
@@ -298,7 +305,7 @@
298305
"name": "python",
299306
"nbconvert_exporter": "python",
300307
"pygments_lexer": "ipython3",
301-
"version": "3.7.3"
308+
"version": "3.7.4"
302309
}
303310
},
304311
"nbformat": 4,

0 commit comments

Comments
 (0)