Skip to content
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.

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

Feature 1453 create pdf user guide #1871

Merged
merged 74 commits into from
Aug 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
aeb600a
Enable PDF creation
ksearight Jun 25, 2021
04d887b
Modify inputenc, fontenc latex_elements
ksearight Jun 25, 2021
492cd2e
Fix typo in conf.py
ksearight Jun 25, 2021
33cabf4
Replace unicode with ascii
ksearight Jun 25, 2021
a1105ee
Replace unicode exponent with math mode
ksearight Jun 25, 2021
87befb3
Change eqnarray to align
ksearight Jun 25, 2021
e0f8223
Replace gif images with png for PDF
ksearight Jun 25, 2021
ea51e96
Fix png file names
ksearight Jun 25, 2021
2063d0d
Escape underscore in variable name in math mode
ksearight Jun 25, 2021
7a5b842
Escape underscore in variable name in math mode
ksearight Jun 25, 2021
0abeda0
Remove underscores from variables in math mode
ksearight Jun 25, 2021
1c72343
Replace bar with overline in some equations
ksearight Jun 25, 2021
31f10c0
Test derefencing underscores in tables
ksearight Jun 25, 2021
b06e622
Test math changes in grid stat
ksearight Jun 25, 2021
7138029
Test math formatting
ksearight Jun 25, 2021
d84f3e0
Test math formatting
ksearight Jun 25, 2021
31acbe8
Add sphinx.ext.pngmath to conf.py
ksearight Jul 15, 2021
9f5fd59
Fix typo in conf.py
ksearight Jul 15, 2021
5dbbc30
Add sphinx.ext.mathjax to conf.py
ksearight Jul 15, 2021
028b354
Add sphinx.ext.imgmath to conf.py
ksearight Jul 15, 2021
e5eeeb3
Fix typo in conf.py
ksearight Jul 15, 2021
12be58d
Change math formatting in Appendix C
ksearight Jul 15, 2021
43bbf74
Temporarily disable equations with errors in Appendix C
ksearight Jul 15, 2021
131564f
Remove sphinx.ext.imgmath in conf.py
ksearight Jul 15, 2021
6291a90
Modify math formatting in Appendix C
ksearight Jul 15, 2021
5889356
Modify math formatting in Appendix C
ksearight Jul 15, 2021
12e7c92
Modify math formatting in Appendix C
ksearight Jul 15, 2021
8d0ea33
Add sphinx.ext.imgmath to conf.py
ksearight Jul 15, 2021
eb177c4
Modify math formatting in Appendix C
ksearight Jul 15, 2021
bc513d8
Temporarily disable equations with errors in Appendix C
ksearight Jul 15, 2021
29d5b0c
Remove sphinx.ext.imgmath in conf.py
ksearight Jul 15, 2021
42320f9
Modify math formatting in Appendix C
ksearight Jul 15, 2021
e725857
Modify math formatting in Appendix C
ksearight Jul 15, 2021
62a0bc0
Temporarily disable equations with errors
ksearight Jul 15, 2021
c853259
Modify math formatting in Appendix C
ksearight Jul 19, 2021
b0b3869
Add usepackage{amssymb} to conf.py
ksearight Jul 19, 2021
e08d1d3
Modify math formatting in Appendix C
ksearight Jul 19, 2021
0a5762f
Modify math formatting in Appendix C
ksearight Jul 19, 2021
18ecff5
Modify math formatting in Appendix C
ksearight Jul 19, 2021
5d46cdb
Modify math formatting in Appendix C
ksearight Jul 19, 2021
5c4bde2
Modify math formatting in Appendix C
ksearight Jul 19, 2021
98d874b
Modify math formatting in Appendix C
ksearight Jul 19, 2021
6c9ad33
Modify math formatting in Appendix C
ksearight Jul 19, 2021
7bf9ca8
Modify math formatting in Appendix C
ksearight Jul 19, 2021
2d63c97
Modify math formatting in Appendix C
ksearight Jul 19, 2021
fc37443
Modify math formatting in Appendix C
ksearight Jul 19, 2021
0a67133
Modify math formatting in Appendix C
ksearight Jul 19, 2021
43fdddc
Modify math formatting in Appendix C
ksearight Jul 19, 2021
f6677b1
Modify math formatting in Appendix C
ksearight Jul 19, 2021
4d6b960
Modify math formatting in Appendix C
ksearight Jul 19, 2021
d5a876f
Modify math formatting in Appendix C
ksearight Jul 19, 2021
bb2c471
Modify math formatting in Appendix C
ksearight Jul 20, 2021
6f483c2
Modify math formatting in Appendix C
ksearight Jul 20, 2021
ff85a53
Fix warnings in wavelet-stat.rst
ksearight Jul 20, 2021
b44b743
Omit Indices and tables in PDF version of User Guide
ksearight Jul 20, 2021
44acf15
Modify math formatting in Appendix G
ksearight Jul 20, 2021
fbf538a
Modify math formatting in Appendix E
ksearight Jul 20, 2021
3a48e02
Modify math formatting in Appendix G
ksearight Jul 20, 2021
17f92d1
Modify math formatting in Appendix G
ksearight Jul 20, 2021
5a6b32f
Modify math formatting in Appendix G
ksearight Jul 20, 2021
be07160
Modify math formatting in Appendix G
ksearight Jul 20, 2021
a05d221
Modify math formatting in Appendix G
ksearight Jul 20, 2021
7c912c5
Modify math formatting in Appendix G
ksearight Jul 20, 2021
c39558f
Modify math formatting in Appendix G
ksearight Jul 20, 2021
d7923a5
Modify math formatting in Appendix G
ksearight Jul 20, 2021
ecf75bc
Modify math formatting in Appendix G
ksearight Jul 20, 2021
0aaeecc
Change release date in conf.py
ksearight Jul 20, 2021
5092bc9
Merge branch 'develop' into feature_1453_create_pdf_user_guide
JohnHalleyGotway Jul 21, 2021
6681a35
Fix merge conflict & remove non-ASCII characters
ksearight Aug 5, 2021
401af08
Move ROC curve in Appendix C
ksearight Aug 5, 2021
99475ae
Crop ROC image for better PDF formatting
ksearight Aug 5, 2021
53c210d
Shrink ROC image for better PDF formatting
ksearight Aug 5, 2021
71335ca
Modify figure alignment in conf.py
ksearight Aug 5, 2021
b1cced1
Change text placement for ROC curve figure
ksearight Aug 5, 2021
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
2 changes: 1 addition & 1 deletion met/docs/Users_Guide/appendixC.rst
Original file line number Diff line number Diff line change
Expand Up @@ -924,7 +924,7 @@ MET produces hit rate (POD) and false alarm rate (POFD) values for each user-spe

A ROC plot is shown for an example set of forecasts, with a solid line connecting the points for six user-specified thresholds (0.25, 0.35, 0.55, 0.65, 0.75, 0.85). The diagonal dashed line indicates no skill while the dash-dot line shows the ROC for a perfect forecast.

An ROC curve shows how well the forecast discriminates between two outcomes, so it is a measure of resolution. The ROC is invariant to linear transformations of the forecast, and is thus unaffected by bias. An unbiased (i.e., well-calibrated) forecast can have the same ROC as a biased forecast, though most would agree that an unbiased forecast is "better". Since the ROC is conditioned on the observations, it is often paired with the reliability diagram, which is conditioned on the forecasts.
A ROC curve shows how well the forecast discriminates between two outcomes, so it is a measure of resolution. The ROC is invariant to linear transformations of the forecast, and is thus unaffected by bias. An unbiased (i.e., well-calibrated) forecast can have the same ROC as a biased forecast, though most would agree that an unbiased forecast is "better". Since the ROC is conditioned on the observations, it is often paired with the reliability diagram, which is conditioned on the forecasts.

.. _appendixC-roc_example:

Expand Down
Binary file modified met/docs/Users_Guide/figure/appendixC-roc_example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions met/docs/Users_Guide/refs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ References
.. _Epstein-1969:

| Epstein, E. S., 1969: A scoring system for probability forecasts of ranked categories.
| *J. Appl. Meteor.*, 8, 985987, 10.1175/1520-0450(1969)008<0985:ASSFPF>2.0.CO;2.
| *J. Appl. Meteor.*, 8, 985-987, 10.1175/1520-0450(1969)008<0985:ASSFPF>2.0.CO;2.
|

.. _Gilleland-2010:
Expand Down Expand Up @@ -167,7 +167,7 @@ References
.. _Mason-2008:

| Mason, S. J., 2008: Understanding forecast verification statistics.
| *Meteor. Appl.*, 15, 3140, doi: 10.1002/met.51.
| *Meteor. Appl.*, 15, 31-40, doi: 10.1002/met.51.
|


Expand All @@ -186,7 +186,7 @@ References
.. _Murphy-1969:

| Murphy, A.H., 1969: On the ranked probability score. *Journal of Applied*
| *Meteorology and Climatology*, 8 (6), 988 989,
| *Meteorology and Climatology*, 8 (6), 988 - 989,
| doi: 10.1175/1520-0450(1969)008<0988:OTPS>2.0.CO;2.
|

Expand Down Expand Up @@ -248,7 +248,7 @@ References

| Tödter, J. and B. Ahrens, 2012: Generalization of the Ignorance Score:
| Continuous ranked version and its decomposition. *Mon. Wea. Rev.*,
| 140 (6), 2005 2017, doi: 10.1175/MWR-D-11-00266.1.
| 140 (6), 2005 - 2017, doi: 10.1175/MWR-D-11-00266.1.
|

.. _Weniger-2016:
Expand Down
4 changes: 2 additions & 2 deletions met/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@
'papersize': 'letterpaper',
'releasename':"{version}",
'fncychap': '\\usepackage{fncychap}',
'fontpkg': '\\usepackage{amsmath,amsfonts,amssymb,amsthm}',
'fontpkg': '\\usepackage{amsmath,amsfonts,amssymb,amsthm,float}',
'inputenc': '\\usepackage[utf8]{inputenc}',
'fontenc': '\\usepackage[LGR,T1]{fontenc}',

'figure_align':'htbp',
'figure_align':'H',
'pointsize': '11pt',

'preamble': r'''
Expand Down