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 #1859

Merged
merged 68 commits into from
Jul 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
68 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
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 .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version: 2

# Build all formats (htmlzip, pdf, epub)
#formats: all
formats: []
formats: [pdf]

# Optionally set the version of Python and requirements required to build your
# docs
Expand Down
4 changes: 2 additions & 2 deletions met/data/map/admin_by_country/admin_Yemen_data
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
12.94042 -45.09903
12.86061 -45.05790
12.80125 -44.85958
4 33 13.829 14.8252 -46.0336 -44.5861 'Al Bayḑā (Yemen)'
4 33 13.829 14.8252 -46.0336 -44.5861 'Al Bayḑā' (Yemen)'
14.53238 -45.11610
14.50399 -45.18688
14.55476 -45.31480
Expand Down Expand Up @@ -579,7 +579,7 @@
17.42610 -43.61780
17.36670 -43.68330
17.33890 -43.83190
17 40 14.7473 16.0428 -45.1087 -43.5061 'Şan‘ā (Yemen)'
17 40 14.7473 16.0428 -45.1087 -43.5061 'Şan‘ā' (Yemen)'
15.12214 -45.08009
14.79469 -44.90892
14.74730 -44.83651
Expand Down
4 changes: 2 additions & 2 deletions met/data/map/admin_data
Original file line number Diff line number Diff line change
Expand Up @@ -82728,7 +82728,7 @@
30.32615 -48.28101
30.20689 -48.39930
30.20050 -48.40535
1193 33 13.829 14.8252 -46.0336 -44.5861 'Al Bayḑā (Yemen)'
1193 33 13.829 14.8252 -46.0336 -44.5861 'Al Bayḑā' (Yemen)'
14.53238 -45.11610
14.50399 -45.18688
14.55476 -45.31480
Expand Down Expand Up @@ -85990,7 +85990,7 @@
35.17110 -43.41893
35.14398 -43.44602
35.05437 -43.54642
1267 40 14.7473 16.0428 -45.1087 -43.5061 'Şan‘ā (Yemen)'
1267 40 14.7473 16.0428 -45.1087 -43.5061 'Şan‘ā' (Yemen)'
15.12214 -45.08009
14.79469 -44.90892
14.74730 -44.83651
Expand Down
6 changes: 3 additions & 3 deletions met/docs/Users_Guide/appendixA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ A. Currently, very few graphics are included. The plotting tools (plot_point_obs

**Q. How do I find the version of the tool I am using?**

A. Type the name of the tool followed by **-version**. For example, type pb2nc **-version**.
A. Type the name of the tool followed by **-version**. For example, type "pb2nc **-version**".

**Q. What are MET's conventions for latitude, longitude, azimuth and bearing angles?**

Expand Down Expand Up @@ -81,11 +81,11 @@ The first place to look for help with individual commands is this user's guide o

**Error while loading shared libraries**

* Add the lib dir to your LD_LIBRARY_PATH. For example, if you receive the following error: ./mode_analysis: error while loading shared libraries: libgsl.so.19: cannot open shared object file: No such file or directory, you should add the path to the gsl lib (for example, */home/user/MET/gsl-2.1/lib*) to your LD_LIBRARY_PATH.
* Add the lib dir to your LD_LIBRARY_PATH. For example, if you receive the following error: "./mode_analysis: error while loading shared libraries: libgsl.so.19: cannot open shared object file: No such file or directory", you should add the path to the gsl lib (for example, */home/user/MET/gsl-2.1/lib*) to your LD_LIBRARY_PATH.

**General troubleshooting**

* For configuration files used, make certain to use empty square brackets (e.g. [ ]) to indicate no stratification is desired. Do NOT use empty double quotation marks inside square brackets (e.g. [“”]).
* For configuration files used, make certain to use empty square brackets (e.g. [ ]) to indicate no stratification is desired. Do NOT use empty double quotation marks inside square brackets (e.g. [""]).

* Have you designated all the required command line arguments?

Expand Down
4 changes: 2 additions & 2 deletions met/docs/Users_Guide/appendixB.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To specify a Lambert Grid, the syntax is

lambert Nx Ny lat_ll lon_ll lon_orient D_km R_km standard_lat_1 [ standard_lat_2 ] N|S

Here, **Nx** and **Ny** are the number of points in, respectively, the **x** and **y** grid directions. These two numbers give the overall size of the grid. **lat_ll** and **lon_ll** are the latitude and longitude, in degrees, of the lower left point of the grid. North latitude and east longitude are considered positive. **lon_orient** is the orientation longitude of the grid. Its the meridian of longitude thats parallel to one of the vertical grid directions. **D_km** and **R_km** are the grid resolution and the radius of the Earth, both in kilometers. **standard_lat_1** and **standard_lat_2** are the standard parallels of the Lambert projection. If the two latitudes are the same, then only one needs to be given. **N|S** means to write either **N** or **S** depending on whether the Lambert projection is from the north pole or the south pole.
Here, **Nx** and **Ny** are the number of points in, respectively, the **x** and **y** grid directions. These two numbers give the overall size of the grid. **lat_ll** and **lon_ll** are the latitude and longitude, in degrees, of the lower left point of the grid. North latitude and east longitude are considered positive. **lon_orient** is the orientation longitude of the grid. It's the meridian of longitude that's parallel to one of the vertical grid directions. **D_km** and **R_km** are the grid resolution and the radius of the Earth, both in kilometers. **standard_lat_1** and **standard_lat_2** are the standard parallels of the Lambert projection. If the two latitudes are the same, then only one needs to be given. **N|S** means to write either **N** or **S** depending on whether the Lambert projection is from the north pole or the south pole.

As an example of specifying a Lambert grid, suppose you have a northern hemisphere Lambert grid with 614 points in the x direction and 428 points in the y direction. The lower left corner of the grid is at latitude :math:`12.190^\circ` north and longitude :math:`133.459^\circ` west. The orientation longitude is :math:`95^\circ` west. The grid spacing is :math:`12.19058^\circ` km. The radius of the Earth is the default value used in many grib files: 6367.47 km. Both standard parallels are at :math:`25^\circ` north. To specify this grid in the config file, you would write

Expand All @@ -55,7 +55,7 @@ For Plate Carrée (i.e. Lat/Lon) grids, the syntax is

latlon Nx Ny lat_ll lon_ll delta_lat delta_lon

The parameters **Nx, Ny, lat_ll** and **lon_ll** are as before. **delta_lat** and **delta_lon** are the latitude and longitude increments of the gridi.e., the change in latitude or longitude between one grid point and an adjacent grid point.
The parameters **Nx, Ny, lat_ll** and **lon_ll** are as before. **delta_lat** and **delta_lon** are the latitude and longitude increments of the grid-i.e., the change in latitude or longitude between one grid point and an adjacent grid point.

For a Rotated Plate Carrée (i.e. Rotated Lat/Lon) grids, the syntax is

Expand Down
Loading