Skip to content

Commit

Permalink
Feature 1453 create pdf user guide (#1859)
Browse files Browse the repository at this point in the history
* Enable PDF creation

* Modify inputenc, fontenc latex_elements

* Fix typo in conf.py

* Replace unicode with ascii

* Replace unicode exponent with math mode

* Change eqnarray to align

* Replace gif images with png for PDF

* Fix png file names

* Escape underscore in variable name in math mode

* Escape underscore in variable name in math mode

* Remove underscores from variables in math mode

* Replace bar with overline in some equations

* Test derefencing underscores in tables

* Test math changes in grid stat

* Test math formatting

* Test math formatting

* Add sphinx.ext.pngmath to conf.py

* Fix typo in conf.py

* Add sphinx.ext.mathjax to conf.py

* Add sphinx.ext.imgmath to conf.py

* Fix typo in conf.py

* Change math formatting in Appendix C

* Temporarily disable equations with errors in Appendix C

* Remove sphinx.ext.imgmath in conf.py

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Add sphinx.ext.imgmath to conf.py

* Modify math formatting in Appendix C

* Temporarily disable equations with errors in Appendix C

* Remove sphinx.ext.imgmath in conf.py

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Temporarily disable equations with errors

* Modify math formatting in Appendix C

* Add usepackage{amssymb} to conf.py

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Modify math formatting in Appendix C

* Fix warnings in wavelet-stat.rst

* Omit Indices and tables in PDF version of User Guide

* Modify math formatting in Appendix G

* Modify math formatting in Appendix E

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Modify math formatting in Appendix G

* Change release date in conf.py

Co-authored-by: John Halley Gotway <[email protected]>
  • Loading branch information
ksearight and JohnHalleyGotway authored Jul 21, 2021
1 parent 3952496 commit 0c0c427
Show file tree
Hide file tree
Showing 38 changed files with 440 additions and 280 deletions.
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

0 comments on commit 0c0c427

Please sign in to comment.