Skip to content

Commit d40a03d

Browse files
authored
User Manual update (#70)
* Update cBLUE version number * Updated VDatum MCU values from NOAA https://vdatum.noaa.gov/docs/est_uncertainties.html * Removed turbidity label text * Move water height up next to enviromental params * Update cBLUE user manual
1 parent eb7d918 commit d40a03d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+211
-113
lines changed

CBlueAppGui.py

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ def main():
136136
root = tk.Tk()
137137
root.wm_title("cBLUE")
138138
root.iconbitmap(root, "cBLUE_icon.ico")
139-
root.geometry("270x740")
139+
root.geometry("270x730")
140140
norm_font_bold = ("Verdanna", 10, "bold")
141141
padx = (30, 30)
142142
pady = (10, 0)
@@ -201,7 +201,6 @@ def main():
201201
dir_frame.pack(padx=padx, pady=pady, fill="x")
202202

203203
# Environmental parameters
204-
205204
def add_tab(options, tab_name, label_text=None):
206205
"""Add tab to Notebook and return Radiobutton variable"""
207206
tab = ttk.Frame(subaqueous_method_tabs)
@@ -219,10 +218,20 @@ def add_tab(options, tab_name, label_text=None):
219218
tk.Label(env_frame, text="Environmental Parameters", font=norm_font_bold).pack()
220219
subaqueous_method_tabs = ttk.Notebook(env_frame)
221220
wind_var = add_tab(WIND_OPTIONS, tab_name="Water Surface")
222-
turbidity_var = add_tab(TURBIDITY_OPTIONS, tab_name="Turbidity", label_text="Turbidity (kd_490)")
221+
turbidity_var = add_tab(TURBIDITY_OPTIONS, tab_name="Turbidity")
223222
subaqueous_method_tabs.pack(fill="x")
224223
env_frame.pack(padx=padx, pady=pady, fill="x")
225224

225+
# Water Height
226+
water_height_frame = tk.Frame(root)
227+
tk.Label(water_height_frame, text="Water Height", font=norm_font_bold).pack()
228+
water_height_var = tk.StringVar()
229+
water_height_var.set(f'{config_dict["water_surface_ellipsoid_height"]:.2f}')
230+
water_height_msg = "Nominal water surface ellipsoid height \n(in meters):"
231+
tk.Label(water_height_frame, text=water_height_msg).pack()
232+
tk.Entry(water_height_frame, textvariable=water_height_var, justify="center").pack()
233+
water_height_frame.pack(padx=padx, pady=pady, fill="x")
234+
226235
# VDatum Region
227236
vdatum_frame = tk.Frame(root)
228237
tk.Label(vdatum_frame, text="VDatum Region", font=norm_font_bold).pack()
@@ -256,16 +265,6 @@ def add_tab(options, tab_name, label_text=None):
256265
ttk.Radiobutton(csv_frame, text="ExtraBytes + CSV", value=True, variable=csv_var).pack(fill="x", padx=padx[-1])
257266
csv_frame.pack(padx=padx, pady=pady, fill="x")
258267

259-
# Water Height
260-
water_height_frame = tk.Frame(root)
261-
tk.Label(water_height_frame, text="Water Height", font=norm_font_bold).pack()
262-
water_height_var = tk.StringVar()
263-
water_height_var.set(f'{config_dict["water_surface_ellipsoid_height"]:.2f}')
264-
water_height_msg = "Nominal water-surface ellipsoid height \n(in meters):"
265-
tk.Label(water_height_frame, text=water_height_msg).pack()
266-
tk.Entry(water_height_frame, textvariable=water_height_var, justify="center").pack()
267-
water_height_frame.pack(padx=padx, pady=pady, fill="x")
268-
269268
def start_process(just_save_config=False):
270269
"""Generate command for CBlueApp.py command line interface. Run the command."""
271270
# Don't allow saving config if process button is disabled

Manual/src/includes/course-info.tex renamed to Manual/cBLUE User Manual - 10-31-23 Update/includes/course-info.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
\newcommand{\semester}{\ }
88
\newcommand{\csection}{\ }
99
\newcommand{\ponderation}{\ }
10-
\newcommand{\coursetitle}{CBlue}
11-
\newcommand{\coursenumber}{[V3.0.0]}
10+
\newcommand{\coursetitle}{cBLUE}
11+
\newcommand{\coursenumber}{[V3.1]}
1212
\newcommand{\prerequisite}{}

Manual/src/includes/document-header.tex renamed to Manual/cBLUE User Manual - 10-31-23 Update/includes/document-header.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
\raggedleft%
1818
{\Large \textsc{\coursetitle { } \coursenumber}\par}
1919
\doublerule % insert a double rule.
20-
\textsc{Author}: \instructor\\
20+
\textsc{Authors}: \instructor \\ and \instructorsecond\\
2121
\end{minipage}%
2222
\vspace{1.0cm}
2323
{

Manual/src/includes/packages.tex renamed to Manual/cBLUE User Manual - 10-31-23 Update/includes/packages.tex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
%-- @see http://ctan.sharelatex.com/tex-archive/fonts/fontawesome/doc/fontawesome.pdf
4545
% Font Awesome http://ctan.math.washington.edu/tex-archive/fonts/fontawesome5/doc/fontawesome5.pdf
4646
% https://muug.ca/mirror/ctan/fonts/fontawesome5/doc/fontawesome5.pdf
47-
\usepackage{fontawesome5}
47+
%\usepackage{fontawesome5}
4848
\usepackage{fontawesome}
4949
%---------------------------------
5050
% ==== Font setup.
@@ -63,11 +63,13 @@
6363

6464
\pagestyle{empty}
6565
\usepackage{graphicx}
66+
\usepackage[export]{adjustbox}
6667
\usepackage{multicol}
6768
\usepackage{blindtext}
6869
\usepackage{vhistory} % for making a table for the revision history.
6970
\usepackage{float}
7071
\usepackage{amsmath}
72+
\usepackage{subfig}
7173

7274
%dummy text - delete me later - no problem!
7375
\usepackage{lipsum}

Manual/src/includes/teacher-info.tex renamed to Manual/cBLUE User Manual - 10-31-23 Update/includes/teacher-info.tex

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@
77
\newcommand{\instructor}{Forrest Corcoran}
88
\newcommand{\college}{Oregon State University}
99
\newcommand{\email}{[email protected]}
10+
\newcommand{\instructorsecond}{Keana Kief}
11+
\newcommand{\emailsecond}{[email protected]}

Manual/src/src/main.tex renamed to Manual/cBLUE User Manual - 10-31-23 Update/src/main.tex

Lines changed: 147 additions & 63 deletions
Large diffs are not rendered by default.

Manual/cBLUE User Manual.pdf

-874 KB
Binary file not shown.

Manual/src/figs/cblue_download.png

-114 KB
Binary file not shown.

Manual/src/figs/cblue_menu.png

-156 KB
Binary file not shown.
-159 KB
Binary file not shown.
-159 KB
Binary file not shown.

Manual/src/figs/env_params.png

-42.7 KB
Binary file not shown.

Manual/src/figs/metric.png

-10.8 KB
Binary file not shown.

Manual/src/figs/nom_h20_surf.png

-42.6 KB
Binary file not shown.

Manual/src/figs/select_las.png

-139 KB
Binary file not shown.

Manual/src/figs/select_out.png

-145 KB
Binary file not shown.

Manual/src/figs/select_traj.png

-143 KB
Binary file not shown.

Manual/src/figs/vdat.png

-14.7 KB
Binary file not shown.

cblue_configuration.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
"multiprocess": "False",
88
"number_cores": 4,
9-
"cBLUE_version": "v3.0",
9+
"cBLUE_version": "v3.1.0",
1010
"sensor_model": "",
1111
"water_surface_ellipsoid_height": 0.00,
1212
"error_type": ""

lookup_tables/V_Datum_MCU_Values.txt

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,49 @@
11
"Maine, New Hampshire, Massachusetts - Gulf of Maine" 13.4
2-
"New York/Connecticut/Rhode Island - Outer NY Bight, eastern Long Island Sound, Block Island Sound" 9.7
3-
New York - The Great South Bay 11.6
4-
"New Jersey/New York/Connecticut - Northern NJ, NY Harbor, western Long Island Sound" 9.4
5-
New Jersey - Coastal embayments 9.2
6-
Virginia/Maryland/Delaware/New Jersey - Mid-Atlantic Bight shelf 8.9
7-
Delaware - Delaware Bay 11.8
8-
Virginia/Maryland/Delaware - Coastal embayments 8.9
9-
Virginia/Maryland - Chesapeake Bay 9.2
10-
North Carolina - Inland waterways and sounds 8.7
11-
North Carolina - Coastal shelf 8.7
12-
Georgia/South Carolina - Sapelo Island GA to the SC/NC border 14.8
13-
"Florida/Georgia - Shelf, Fort Lauderdale FL to Sapelo Island GA" 9.3
14-
"Florida/Georgia - Inland water, Fort Lauderdale FL to Sapelo Is" 10
2+
"New York/Connecticut/Rhode Island - Outer NY Bight, eastern Long Island Sound, Block Island Sound" 9.4
3+
"New York - The Great South Bay" 9.4
4+
"New Jersey/New York/Connecticut - Northern NJ, NY Harbor, western Long Island Sound" 9.1
5+
"New Jersey - Coastal embayments - North" 9.0
6+
"New Jersey - Coastal embayments - South" 6.5
7+
"Virginia/Maryland/Delaware/New Jersey - Mid-Atlantic Bight shelf" 6.8
8+
"Delaware - Delaware Bay" 6.4
9+
"Virginia/Maryland - East Chesapeake Bay" 6.5
10+
"Maryland - Northwest Chesapeake Bay" 6.5
11+
"Virginia - Southwest Chesapeake Bay" 6.5
12+
"Virginia/Maryland/Delaware - Coastal embayments" 6.6
13+
"North Carolina - Inland waterways and sounds" 9.9
14+
"North Carolina - Coastal shelf" 9.9
15+
"Georgia/South Carolina/North Carolina-Sapelo Island GA to Holden Beach NC" 15.5
16+
"Florida/Georgia - Shelf, Fort Lauderdale FL to Sapelo Island GA" 10.4
17+
"Florida/Georgia - Inland water, Fort Lauderdale FL to Sapelo Is" 11.1
1518
"Florida - South Florida, Naples to Fort Lauderdale FL, and Florida Bay" 9.6
16-
Florida - South Florida Inland Waterways 9.4
17-
Florida - Anclote Key to Naples 13
18-
Florida - Apalachicola to Anclote Key 10.2
19-
Florida - St. Joseph Bay and the Gulf of Mexico 8.6
20-
Florida - St. Andrews Bay and the Gulf of Mexico 8
19+
"Florida - South Florida Inland Waterways" 9.4
20+
"Florida - Anclote Key to Naples" 13.0
21+
"Florida - Apalachicola to Anclote Key" 10.2
22+
"Florida - St. Joseph Bay and the Gulf of Mexico" 8.6
23+
"Florida - St. Andrews Bay and the Gulf of Mexico" 8.0
2124
"Florida - Perdido, Pensacola and Choctawhatchee Bays" 8.3
22-
Florida/Alabama - Gulf of Mexico from Mobile Bay to east of Choctawhatchee Bay 8.1
23-
Alabama - Mobile Bay and Perdido Bay 8.2
24-
Louisiana/Mississippi - Eastern Louisiana to Mississippi Sound 17.1
25-
Louisiana/Texas - western Louisiana to Galveston Bay 12.8
25+
"Florida/Alabama - Gulf of Mexico from Mobile Bay to east of Choctawhatchee Bay" 8.1
26+
"Alabama - Mobile Bay and Perdido Bay" 8.2
27+
"Louisiana/Mississippi - Eastern Louisiana to Mississippi Sound" 17.1
28+
"Louisiana/Texas - western Louisiana to Galveston Bay" 12.8
2629
"Texas - Lagoons, Galveston Bay to Matagorda Island" 12.5
2730
"Texas - Shelf, Galveston Bay to Matagorda Is." 9.4
28-
"Texas - Lagoons, Matagorda Island to US/Mexico border" 15.9
31+
"Texas - Lagoons, Matagorda Island to US/Mexico border" 15.8
2932
"Texas - Shelf, Matagorda Island to US/Mexico border" 8.2
30-
California - Southern California from Morro Bay south to US/Mexico border 8.1
31-
California - Monterey Bay to Morro Bay 8
32-
California - San Francisco Bay Vicinity 10.1
33-
Oregon/ California - Punta Gorda to Cape Blanco 13.1
34-
Oregon - Central Oregon 19.4
35-
Washington/Oregon - Columbia River and Southern Washington 22.6
36-
Washington - Strait of Juan de Fuca 14
37-
Washington - Puget Sound 9.7
38-
Puerto Rico and U.S Virgin Islands (uses PRVD02 and VIVD09 instead of NAVD88) 11.8
33+
"California - Southern California" 7.5
34+
"California - Southern California Inland" 6.7
35+
"California -Monterey Bay to Morro Bay" 8.0
36+
"California - San Francisco Bay Vicinity" 7.7
37+
"California - San Francisco Bay Inland" 6.5
38+
"California/Oregon - Coastal" 7.8
39+
"Oregon - Coastal Inland" 6.5
40+
"Oregon - Coastal" 7.8
41+
"Washington - Coastal" 7.9
42+
"Washington - Strait of Juan de Fuca Inland" 6.9
43+
"Washington - Strait of Juan de Fuca" 7.2
44+
"Washington - Puget Sound" 7.1
45+
"Washington/Oregon/California - Offshore" 9.1
46+
"Puerto Rico and U.S Virgin Islands (uses PRVD02 and VIVD09 instead of NAVD88)" 7.4
47+
"Alaska - Southeast, Yakutat to Glacier Bay" 13.2
48+
"Alaska - Southeast, Glacier Bay to Whale Bay" 13.2
49+
"Alaska - Southeast, Whale Bay to US/Canada Border" 13.2

0 commit comments

Comments
 (0)