diff --git a/dev/_downloads/04091983300c9d76934920483fb09dd4/Sounding_Calculations.zip b/dev/_downloads/04091983300c9d76934920483fb09dd4/Sounding_Calculations.zip index 0cce6a8cab4..3816dd7f505 100644 Binary files a/dev/_downloads/04091983300c9d76934920483fb09dd4/Sounding_Calculations.zip and b/dev/_downloads/04091983300c9d76934920483fb09dd4/Sounding_Calculations.zip differ diff --git a/dev/_downloads/082a0fab3fe1251c35a5c076fbfdaaaf/Bulk_Shear.zip b/dev/_downloads/082a0fab3fe1251c35a5c076fbfdaaaf/Bulk_Shear.zip index 3d73048b18b..116ac5be0de 100644 Binary files a/dev/_downloads/082a0fab3fe1251c35a5c076fbfdaaaf/Bulk_Shear.zip and b/dev/_downloads/082a0fab3fe1251c35a5c076fbfdaaaf/Bulk_Shear.zip differ diff --git a/dev/_downloads/1523f155da5959646e27c2eaca8007cb/Station_Plot.zip b/dev/_downloads/1523f155da5959646e27c2eaca8007cb/Station_Plot.zip index eb22ff1d0bb..0dec67d8b65 100644 Binary files a/dev/_downloads/1523f155da5959646e27c2eaca8007cb/Station_Plot.zip and b/dev/_downloads/1523f155da5959646e27c2eaca8007cb/Station_Plot.zip differ diff --git a/dev/_downloads/186f76b65eb386871fc9c26bdc9f01a8/Shearing_Deformation.zip b/dev/_downloads/186f76b65eb386871fc9c26bdc9f01a8/Shearing_Deformation.zip index 83548db24b0..796eb42655b 100644 Binary files a/dev/_downloads/186f76b65eb386871fc9c26bdc9f01a8/Shearing_Deformation.zip and b/dev/_downloads/186f76b65eb386871fc9c26bdc9f01a8/Shearing_Deformation.zip differ diff --git a/dev/_downloads/1aa267885c4b6699e5357f95474588e6/Divergence.zip b/dev/_downloads/1aa267885c4b6699e5357f95474588e6/Divergence.zip index 860bd034e2b..5ffbfc092a2 100644 Binary files a/dev/_downloads/1aa267885c4b6699e5357f95474588e6/Divergence.zip and b/dev/_downloads/1aa267885c4b6699e5357f95474588e6/Divergence.zip differ diff --git a/dev/_downloads/223464c6999313f83e02eb5c019ff9b9/Mean_Pressure_Weighted.zip b/dev/_downloads/223464c6999313f83e02eb5c019ff9b9/Mean_Pressure_Weighted.zip index afd39286c69..b8609e247bb 100644 Binary files a/dev/_downloads/223464c6999313f83e02eb5c019ff9b9/Mean_Pressure_Weighted.zip and b/dev/_downloads/223464c6999313f83e02eb5c019ff9b9/Mean_Pressure_Weighted.zip differ diff --git a/dev/_downloads/2808cb1a9037924da492d35f733a3d30/NEXRAD_Level_2_File.zip b/dev/_downloads/2808cb1a9037924da492d35f733a3d30/NEXRAD_Level_2_File.zip index 07e2c77cf61..07b74d9272b 100644 Binary files a/dev/_downloads/2808cb1a9037924da492d35f733a3d30/NEXRAD_Level_2_File.zip and b/dev/_downloads/2808cb1a9037924da492d35f733a3d30/NEXRAD_Level_2_File.zip differ diff --git a/dev/_downloads/2d7bbe850f0058199c1bf791e3692674/Thickness_Hydrostatic.zip b/dev/_downloads/2d7bbe850f0058199c1bf791e3692674/Thickness_Hydrostatic.zip index 9dfe6be3aa2..e7f8638e57c 100644 Binary files a/dev/_downloads/2d7bbe850f0058199c1bf791e3692674/Thickness_Hydrostatic.zip and b/dev/_downloads/2d7bbe850f0058199c1bf791e3692674/Thickness_Hydrostatic.zip differ diff --git a/dev/_downloads/315c4c52fb68082a731b192d944e2ede/tutorials_python.zip b/dev/_downloads/315c4c52fb68082a731b192d944e2ede/tutorials_python.zip index 813cc8a529f..bf4dac6b8bf 100644 Binary files a/dev/_downloads/315c4c52fb68082a731b192d944e2ede/tutorials_python.zip and b/dev/_downloads/315c4c52fb68082a731b192d944e2ede/tutorials_python.zip differ diff --git a/dev/_downloads/31813974eb412911b1c6bda94099f526/Simple_Sounding.zip b/dev/_downloads/31813974eb412911b1c6bda94099f526/Simple_Sounding.zip index 88c68eef001..412ec6f3bc4 100644 Binary files a/dev/_downloads/31813974eb412911b1c6bda94099f526/Simple_Sounding.zip and b/dev/_downloads/31813974eb412911b1c6bda94099f526/Simple_Sounding.zip differ diff --git a/dev/_downloads/391a346607fba108abe6b68528840293/spc_convective_outlook.zip b/dev/_downloads/391a346607fba108abe6b68528840293/spc_convective_outlook.zip index 89d3c97e2d2..f1b04d8197d 100644 Binary files a/dev/_downloads/391a346607fba108abe6b68528840293/spc_convective_outlook.zip and b/dev/_downloads/391a346607fba108abe6b68528840293/spc_convective_outlook.zip differ diff --git a/dev/_downloads/3e38c5c75bb4d6464fa44d5b8c799fcb/nhc_wind_probabilities.zip b/dev/_downloads/3e38c5c75bb4d6464fa44d5b8c799fcb/nhc_wind_probabilities.zip index 47b2e3a73a3..2e198f0f6f4 100644 Binary files a/dev/_downloads/3e38c5c75bb4d6464fa44d5b8c799fcb/nhc_wind_probabilities.zip and b/dev/_downloads/3e38c5c75bb4d6464fa44d5b8c799fcb/nhc_wind_probabilities.zip differ diff --git a/dev/_downloads/49d7ea5ec0bc9e13dde88ca3c0595d99/Simple_Fronts_Plot.zip b/dev/_downloads/49d7ea5ec0bc9e13dde88ca3c0595d99/Simple_Fronts_Plot.zip index 1e5bc0e9609..c2292cb4281 100644 Binary files a/dev/_downloads/49d7ea5ec0bc9e13dde88ca3c0595d99/Simple_Fronts_Plot.zip and b/dev/_downloads/49d7ea5ec0bc9e13dde88ca3c0595d99/Simple_Fronts_Plot.zip differ diff --git a/dev/_downloads/4d77f41b11d925bd339ed71d7280b8e5/Simplified_Image_Plot.zip b/dev/_downloads/4d77f41b11d925bd339ed71d7280b8e5/Simplified_Image_Plot.zip index c0c7feedbe1..d239c32af77 100644 Binary files a/dev/_downloads/4d77f41b11d925bd339ed71d7280b8e5/Simplified_Image_Plot.zip and b/dev/_downloads/4d77f41b11d925bd339ed71d7280b8e5/Simplified_Image_Plot.zip differ diff --git a/dev/_downloads/4e34e956bf42cdd7b999e346f01c9970/Mountain_Problem.zip b/dev/_downloads/4e34e956bf42cdd7b999e346f01c9970/Mountain_Problem.zip index 2cd1d72cd77..083b24e3bd1 100644 Binary files a/dev/_downloads/4e34e956bf42cdd7b999e346f01c9970/Mountain_Problem.zip and b/dev/_downloads/4e34e956bf42cdd7b999e346f01c9970/Mountain_Problem.zip differ diff --git a/dev/_downloads/52a7c4e2d2473999748f1de66b9de91d/Parse_Angles.zip b/dev/_downloads/52a7c4e2d2473999748f1de66b9de91d/Parse_Angles.zip index df5cfebfc76..e59a69b6b83 100644 Binary files a/dev/_downloads/52a7c4e2d2473999748f1de66b9de91d/Parse_Angles.zip and b/dev/_downloads/52a7c4e2d2473999748f1de66b9de91d/Parse_Angles.zip differ diff --git a/dev/_downloads/57d6d44952165edb028aa8c8559b55d3/surface_declarative.zip b/dev/_downloads/57d6d44952165edb028aa8c8559b55d3/surface_declarative.zip index 029ef3bab58..7044a620df0 100644 Binary files a/dev/_downloads/57d6d44952165edb028aa8c8559b55d3/surface_declarative.zip and b/dev/_downloads/57d6d44952165edb028aa8c8559b55d3/surface_declarative.zip differ diff --git a/dev/_downloads/58fa1be74d5031f1cf1abcd11aa829af/Advanced_Sounding.zip b/dev/_downloads/58fa1be74d5031f1cf1abcd11aa829af/Advanced_Sounding.zip index cbd8b0d726d..703e0331bc7 100644 Binary files a/dev/_downloads/58fa1be74d5031f1cf1abcd11aa829af/Advanced_Sounding.zip and b/dev/_downloads/58fa1be74d5031f1cf1abcd11aa829af/Advanced_Sounding.zip differ diff --git a/dev/_downloads/5f90e294a201c0274e0706051a82664f/Inverse_Distance_Verification.zip b/dev/_downloads/5f90e294a201c0274e0706051a82664f/Inverse_Distance_Verification.zip index 981fb17b0fa..795f061a1a3 100644 Binary files a/dev/_downloads/5f90e294a201c0274e0706051a82664f/Inverse_Distance_Verification.zip and b/dev/_downloads/5f90e294a201c0274e0706051a82664f/Inverse_Distance_Verification.zip differ diff --git a/dev/_downloads/62e923f8d30033952a29553f5e77f504/Natural_Neighbor_Verification.zip b/dev/_downloads/62e923f8d30033952a29553f5e77f504/Natural_Neighbor_Verification.zip index 12f3389bc2b..dacad899513 100644 Binary files a/dev/_downloads/62e923f8d30033952a29553f5e77f504/Natural_Neighbor_Verification.zip and b/dev/_downloads/62e923f8d30033952a29553f5e77f504/Natural_Neighbor_Verification.zip differ diff --git a/dev/_downloads/6be032dea76e814e09bc510d28e56dbc/sigma_to_pressure_interpolation.zip b/dev/_downloads/6be032dea76e814e09bc510d28e56dbc/sigma_to_pressure_interpolation.zip index 1b80083e6d0..4be2be7e717 100644 Binary files a/dev/_downloads/6be032dea76e814e09bc510d28e56dbc/sigma_to_pressure_interpolation.zip and b/dev/_downloads/6be032dea76e814e09bc510d28e56dbc/sigma_to_pressure_interpolation.zip differ diff --git a/dev/_downloads/6c291187574af09ff3b2be4526f3eb49/upperair_declarative.zip b/dev/_downloads/6c291187574af09ff3b2be4526f3eb49/upperair_declarative.zip index 01c0784c491..def09a0c8a5 100644 Binary files a/dev/_downloads/6c291187574af09ff3b2be4526f3eb49/upperair_declarative.zip and b/dev/_downloads/6c291187574af09ff3b2be4526f3eb49/upperair_declarative.zip differ diff --git a/dev/_downloads/6d9542ee3875e792f1dc61bd0b74c756/Sounding_LCL_Dataset.zip b/dev/_downloads/6d9542ee3875e792f1dc61bd0b74c756/Sounding_LCL_Dataset.zip index 38307f8d4a9..4b948eb3324 100644 Binary files a/dev/_downloads/6d9542ee3875e792f1dc61bd0b74c756/Sounding_LCL_Dataset.zip and b/dev/_downloads/6d9542ee3875e792f1dc61bd0b74c756/Sounding_LCL_Dataset.zip differ diff --git a/dev/_downloads/72c1ab8bbac54e1b0efbca160a2a1045/meteogram_metpy.zip b/dev/_downloads/72c1ab8bbac54e1b0efbca160a2a1045/meteogram_metpy.zip index 446d0455f96..cc969cefa14 100644 Binary files a/dev/_downloads/72c1ab8bbac54e1b0efbca160a2a1045/meteogram_metpy.zip and b/dev/_downloads/72c1ab8bbac54e1b0efbca160a2a1045/meteogram_metpy.zip differ diff --git a/dev/_downloads/78b733bd37148dbb5ae99df3a7fabf14/QVector.zip b/dev/_downloads/78b733bd37148dbb5ae99df3a7fabf14/QVector.zip index a2c56e1917f..b5cd99ee6c9 100644 Binary files a/dev/_downloads/78b733bd37148dbb5ae99df3a7fabf14/QVector.zip and b/dev/_downloads/78b733bd37148dbb5ae99df3a7fabf14/QVector.zip differ diff --git a/dev/_downloads/7943298fe2c9f2ecf278bd9338cb73b3/Hodograph_Inset.zip b/dev/_downloads/7943298fe2c9f2ecf278bd9338cb73b3/Hodograph_Inset.zip index b641fd40f0a..565e631d19b 100644 Binary files a/dev/_downloads/7943298fe2c9f2ecf278bd9338cb73b3/Hodograph_Inset.zip and b/dev/_downloads/7943298fe2c9f2ecf278bd9338cb73b3/Hodograph_Inset.zip differ diff --git a/dev/_downloads/798c524490b00f114a45502c2fbfd8a5/Static_Stability.zip b/dev/_downloads/798c524490b00f114a45502c2fbfd8a5/Static_Stability.zip index 9c3e4d763d1..3c5d81d2226 100644 Binary files a/dev/_downloads/798c524490b00f114a45502c2fbfd8a5/Static_Stability.zip and b/dev/_downloads/798c524490b00f114a45502c2fbfd8a5/Static_Stability.zip differ diff --git a/dev/_downloads/79f9cee6909ee82905c24b19201cea97/cross_section.zip b/dev/_downloads/79f9cee6909ee82905c24b19201cea97/cross_section.zip index be0f1d52e1c..34539582667 100644 Binary files a/dev/_downloads/79f9cee6909ee82905c24b19201cea97/cross_section.zip and b/dev/_downloads/79f9cee6909ee82905c24b19201cea97/cross_section.zip differ diff --git a/dev/_downloads/7ad5a62cb10cfd5d67f19e01218a8d48/Smoothing.zip b/dev/_downloads/7ad5a62cb10cfd5d67f19e01218a8d48/Smoothing.zip index a9277cb8420..034560f0b7b 100644 Binary files a/dev/_downloads/7ad5a62cb10cfd5d67f19e01218a8d48/Smoothing.zip and b/dev/_downloads/7ad5a62cb10cfd5d67f19e01218a8d48/Smoothing.zip differ diff --git a/dev/_downloads/7bd126fa6cb565445b0c1599f069b6e9/GINI_Water_Vapor.zip b/dev/_downloads/7bd126fa6cb565445b0c1599f069b6e9/GINI_Water_Vapor.zip index d7155623920..de8142bcac7 100644 Binary files a/dev/_downloads/7bd126fa6cb565445b0c1599f069b6e9/GINI_Water_Vapor.zip and b/dev/_downloads/7bd126fa6cb565445b0c1599f069b6e9/GINI_Water_Vapor.zip differ diff --git a/dev/_downloads/812f3156f2a51c954475034b88879535/unit_tutorial.zip b/dev/_downloads/812f3156f2a51c954475034b88879535/unit_tutorial.zip index 4629ecaa5b9..3f04ff11af5 100644 Binary files a/dev/_downloads/812f3156f2a51c954475034b88879535/unit_tutorial.zip and b/dev/_downloads/812f3156f2a51c954475034b88879535/unit_tutorial.zip differ diff --git a/dev/_downloads/8a534b0f8eef2be52cfac0a885b698db/Skew-T_Layout.zip b/dev/_downloads/8a534b0f8eef2be52cfac0a885b698db/Skew-T_Layout.zip index 0313483ebce..5c34843f15c 100644 Binary files a/dev/_downloads/8a534b0f8eef2be52cfac0a885b698db/Skew-T_Layout.zip and b/dev/_downloads/8a534b0f8eef2be52cfac0a885b698db/Skew-T_Layout.zip differ diff --git a/dev/_downloads/8b1e37ecb6ea1420f63e73b993a64429/declarative_tutorial.zip b/dev/_downloads/8b1e37ecb6ea1420f63e73b993a64429/declarative_tutorial.zip index baf0f026aaf..2e59e9d86bb 100644 Binary files a/dev/_downloads/8b1e37ecb6ea1420f63e73b993a64429/declarative_tutorial.zip and b/dev/_downloads/8b1e37ecb6ea1420f63e73b993a64429/declarative_tutorial.zip differ diff --git a/dev/_downloads/8bb14be7992a8b47d8955dc55a0b8998/Point_Interpolation.zip b/dev/_downloads/8bb14be7992a8b47d8955dc55a0b8998/Point_Interpolation.zip index 05d69152f87..5935c4a93aa 100644 Binary files a/dev/_downloads/8bb14be7992a8b47d8955dc55a0b8998/Point_Interpolation.zip and b/dev/_downloads/8bb14be7992a8b47d8955dc55a0b8998/Point_Interpolation.zip differ diff --git a/dev/_downloads/8ff108031b7c751c3f1a095fa4e919b7/Combined_plotting.zip b/dev/_downloads/8ff108031b7c751c3f1a095fa4e919b7/Combined_plotting.zip index 660d3ff44fd..3cc45c33974 100644 Binary files a/dev/_downloads/8ff108031b7c751c3f1a095fa4e919b7/Combined_plotting.zip and b/dev/_downloads/8ff108031b7c751c3f1a095fa4e919b7/Combined_plotting.zip differ diff --git a/dev/_downloads/96c7ca2f942ccedb687afb8e2dcd38c5/Stretching_Deformation.zip b/dev/_downloads/96c7ca2f942ccedb687afb8e2dcd38c5/Stretching_Deformation.zip index 5c070359373..76302c4a9fe 100644 Binary files a/dev/_downloads/96c7ca2f942ccedb687afb8e2dcd38c5/Stretching_Deformation.zip and b/dev/_downloads/96c7ca2f942ccedb687afb8e2dcd38c5/Stretching_Deformation.zip differ diff --git a/dev/_downloads/9b7dd84e43ccdced20835cdd39aedfc3/Equivalent_Potential_Temperature.zip b/dev/_downloads/9b7dd84e43ccdced20835cdd39aedfc3/Equivalent_Potential_Temperature.zip index b323434b9e2..751170e22bb 100644 Binary files a/dev/_downloads/9b7dd84e43ccdced20835cdd39aedfc3/Equivalent_Potential_Temperature.zip and b/dev/_downloads/9b7dd84e43ccdced20835cdd39aedfc3/Equivalent_Potential_Temperature.zip differ diff --git a/dev/_downloads/9faef570fc51bd5dd009671938bd871c/Mesonet_Stationplot.zip b/dev/_downloads/9faef570fc51bd5dd009671938bd871c/Mesonet_Stationplot.zip index 42d50b90ff5..99f26d49825 100644 Binary files a/dev/_downloads/9faef570fc51bd5dd009671938bd871c/Mesonet_Stationplot.zip and b/dev/_downloads/9faef570fc51bd5dd009671938bd871c/Mesonet_Stationplot.zip differ diff --git a/dev/_downloads/a4d07c40491d156e595f7d888e814cd6/Wind_SLP_Interpolation.zip b/dev/_downloads/a4d07c40491d156e595f7d888e814cd6/Wind_SLP_Interpolation.zip index 20149913f61..278651a5df5 100644 Binary files a/dev/_downloads/a4d07c40491d156e595f7d888e814cd6/Wind_SLP_Interpolation.zip and b/dev/_downloads/a4d07c40491d156e595f7d888e814cd6/Wind_SLP_Interpolation.zip differ diff --git a/dev/_downloads/a5659940aa3f8f568547d47752a43172/tutorials_jupyter.zip b/dev/_downloads/a5659940aa3f8f568547d47752a43172/tutorials_jupyter.zip index 8266bf42e11..f94efd40df1 100644 Binary files a/dev/_downloads/a5659940aa3f8f568547d47752a43172/tutorials_jupyter.zip and b/dev/_downloads/a5659940aa3f8f568547d47752a43172/tutorials_jupyter.zip differ diff --git a/dev/_downloads/a58816c4f3cacfddb44ac6fe03c60c83/area_tutorial.zip b/dev/_downloads/a58816c4f3cacfddb44ac6fe03c60c83/area_tutorial.zip index 59b5dc28238..48f6f9506d5 100644 Binary files a/dev/_downloads/a58816c4f3cacfddb44ac6fe03c60c83/area_tutorial.zip and b/dev/_downloads/a58816c4f3cacfddb44ac6fe03c60c83/area_tutorial.zip differ diff --git a/dev/_downloads/a9865f924ac162dbfaec8a8730ee0fa7/Four_Panel_Map.zip b/dev/_downloads/a9865f924ac162dbfaec8a8730ee0fa7/Four_Panel_Map.zip index a70c094db02..2419dab1837 100644 Binary files a/dev/_downloads/a9865f924ac162dbfaec8a8730ee0fa7/Four_Panel_Map.zip and b/dev/_downloads/a9865f924ac162dbfaec8a8730ee0fa7/Four_Panel_Map.zip differ diff --git a/dev/_downloads/a9ceb4ec46157661288e2e9ae217acb8/Station_Plot_with_Layout.zip b/dev/_downloads/a9ceb4ec46157661288e2e9ae217acb8/Station_Plot_with_Layout.zip index 954f67953c0..162faef3a8f 100644 Binary files a/dev/_downloads/a9ceb4ec46157661288e2e9ae217acb8/Station_Plot_with_Layout.zip and b/dev/_downloads/a9ceb4ec46157661288e2e9ae217acb8/Station_Plot_with_Layout.zip differ diff --git a/dev/_downloads/aa64c1fe208dc564b58dbc1fbb98815e/upperair_soundings.zip b/dev/_downloads/aa64c1fe208dc564b58dbc1fbb98815e/upperair_soundings.zip index bd66b797e65..2093e5178b4 100644 Binary files a/dev/_downloads/aa64c1fe208dc564b58dbc1fbb98815e/upperair_soundings.zip and b/dev/_downloads/aa64c1fe208dc564b58dbc1fbb98815e/upperair_soundings.zip differ diff --git a/dev/_downloads/ab88a08765f1d272c076bab274bba032/raster_declarative.zip b/dev/_downloads/ab88a08765f1d272c076bab274bba032/raster_declarative.zip index 89f6d890911..3b407500a20 100644 Binary files a/dev/_downloads/ab88a08765f1d272c076bab274bba032/raster_declarative.zip and b/dev/_downloads/ab88a08765f1d272c076bab274bba032/raster_declarative.zip differ diff --git a/dev/_downloads/b26d4e2fdd7041ec514bd2e950aecf1c/Plotting_Surface_Analysis.zip b/dev/_downloads/b26d4e2fdd7041ec514bd2e950aecf1c/Plotting_Surface_Analysis.zip index 027437fa425..1c181209147 100644 Binary files a/dev/_downloads/b26d4e2fdd7041ec514bd2e950aecf1c/Plotting_Surface_Analysis.zip and b/dev/_downloads/b26d4e2fdd7041ec514bd2e950aecf1c/Plotting_Surface_Analysis.zip differ diff --git a/dev/_downloads/b9b40fccba1d6ec403d5a7b598d53c8b/Total_Deformation.zip b/dev/_downloads/b9b40fccba1d6ec403d5a7b598d53c8b/Total_Deformation.zip index a81fcb27f33..9b956c1ffac 100644 Binary files a/dev/_downloads/b9b40fccba1d6ec403d5a7b598d53c8b/Total_Deformation.zip and b/dev/_downloads/b9b40fccba1d6ec403d5a7b598d53c8b/Total_Deformation.zip differ diff --git a/dev/_downloads/bacdb1a56b06049d5bfcf2fe02725944/Wind_Speed.zip b/dev/_downloads/bacdb1a56b06049d5bfcf2fe02725944/Wind_Speed.zip index 7951decc0a7..b4b2c846b7b 100644 Binary files a/dev/_downloads/bacdb1a56b06049d5bfcf2fe02725944/Wind_Speed.zip and b/dev/_downloads/bacdb1a56b06049d5bfcf2fe02725944/Wind_Speed.zip differ diff --git a/dev/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip b/dev/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip index 1d18bfa1198..4397ebde2c0 100644 Binary files a/dev/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip and b/dev/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip differ diff --git a/dev/_downloads/be2506e9768df69d9457b96f198a256d/NEXRAD_Level_3_File.zip b/dev/_downloads/be2506e9768df69d9457b96f198a256d/NEXRAD_Level_3_File.zip index 276d2454b76..75ec0e36c34 100644 Binary files a/dev/_downloads/be2506e9768df69d9457b96f198a256d/NEXRAD_Level_3_File.zip and b/dev/_downloads/be2506e9768df69d9457b96f198a256d/NEXRAD_Level_3_File.zip differ diff --git a/dev/_downloads/c3ed37a5ecf3e5a9c07a95643273f96d/Gradient.zip b/dev/_downloads/c3ed37a5ecf3e5a9c07a95643273f96d/Gradient.zip index 941d22f7c81..3089c01afd2 100644 Binary files a/dev/_downloads/c3ed37a5ecf3e5a9c07a95643273f96d/Gradient.zip and b/dev/_downloads/c3ed37a5ecf3e5a9c07a95643273f96d/Gradient.zip differ diff --git a/dev/_downloads/cb658440e8d09585894269f064ded2b5/XArray_Projections.zip b/dev/_downloads/cb658440e8d09585894269f064ded2b5/XArray_Projections.zip index 1f799303b60..d36a6e35696 100644 Binary files a/dev/_downloads/cb658440e8d09585894269f064ded2b5/XArray_Projections.zip and b/dev/_downloads/cb658440e8d09585894269f064ded2b5/XArray_Projections.zip differ diff --git a/dev/_downloads/cf493007bfaf574af871ec427f8cd081/xarray_tutorial.zip b/dev/_downloads/cf493007bfaf574af871ec427f8cd081/xarray_tutorial.zip index e4e00c33436..3d7cd4627bc 100644 Binary files a/dev/_downloads/cf493007bfaf574af871ec427f8cd081/xarray_tutorial.zip and b/dev/_downloads/cf493007bfaf574af871ec427f8cd081/xarray_tutorial.zip differ diff --git a/dev/_downloads/d7027451c04b467ccd181464c81c91de/Advection.zip b/dev/_downloads/d7027451c04b467ccd181464c81c91de/Advection.zip index bdc5be1b50a..e906da4c81b 100644 Binary files a/dev/_downloads/d7027451c04b467ccd181464c81c91de/Advection.zip and b/dev/_downloads/d7027451c04b467ccd181464c81c91de/Advection.zip differ diff --git a/dev/_downloads/e04a4687e37e78a1540e9bf9a2be58cf/Angle_to_Direction.zip b/dev/_downloads/e04a4687e37e78a1540e9bf9a2be58cf/Angle_to_Direction.zip index a0c38ecd566..2f4f668b9ed 100644 Binary files a/dev/_downloads/e04a4687e37e78a1540e9bf9a2be58cf/Angle_to_Direction.zip and b/dev/_downloads/e04a4687e37e78a1540e9bf9a2be58cf/Angle_to_Direction.zip differ diff --git a/dev/_downloads/e50a0b920fc44505e926eaeef27dacd5/US_Counties.zip b/dev/_downloads/e50a0b920fc44505e926eaeef27dacd5/US_Counties.zip index 267b811d94a..fd256159674 100644 Binary files a/dev/_downloads/e50a0b920fc44505e926eaeef27dacd5/US_Counties.zip and b/dev/_downloads/e50a0b920fc44505e926eaeef27dacd5/US_Counties.zip differ diff --git a/dev/_downloads/ebb53fe327f4e3111346bcb4d3b19628/Advanced_Sounding_With_Complex_Layout.zip b/dev/_downloads/ebb53fe327f4e3111346bcb4d3b19628/Advanced_Sounding_With_Complex_Layout.zip index dde00fb4397..b88349e58f2 100644 Binary files a/dev/_downloads/ebb53fe327f4e3111346bcb4d3b19628/Advanced_Sounding_With_Complex_Layout.zip and b/dev/_downloads/ebb53fe327f4e3111346bcb4d3b19628/Advanced_Sounding_With_Complex_Layout.zip differ diff --git a/dev/_downloads/edbabfc70e586be80f76255a8ca83650/isentropic_example.zip b/dev/_downloads/edbabfc70e586be80f76255a8ca83650/isentropic_example.zip index 8c17670207d..76e0aef8f8c 100644 Binary files a/dev/_downloads/edbabfc70e586be80f76255a8ca83650/isentropic_example.zip and b/dev/_downloads/edbabfc70e586be80f76255a8ca83650/isentropic_example.zip differ diff --git a/dev/_downloads/f335ba0ca08bde86784c71d671d92211/Vorticity.zip b/dev/_downloads/f335ba0ca08bde86784c71d671d92211/Vorticity.zip index 1199efb215c..56a51ec2b9b 100644 Binary files a/dev/_downloads/f335ba0ca08bde86784c71d671d92211/Vorticity.zip and b/dev/_downloads/f335ba0ca08bde86784c71d671d92211/Vorticity.zip differ diff --git a/dev/_downloads/f850536e444ce727028d67e0633d2c84/Dewpoint_and_Mixing_Ratio.zip b/dev/_downloads/f850536e444ce727028d67e0633d2c84/Dewpoint_and_Mixing_Ratio.zip index 42534d628f7..8977157ffe9 100644 Binary files a/dev/_downloads/f850536e444ce727028d67e0633d2c84/Dewpoint_and_Mixing_Ratio.zip and b/dev/_downloads/f850536e444ce727028d67e0633d2c84/Dewpoint_and_Mixing_Ratio.zip differ diff --git a/dev/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip b/dev/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip index e84922ddbf0..b36bb1c8be5 100644 Binary files a/dev/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip and b/dev/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip differ diff --git a/dev/_downloads/fbe57406f64b85e1cff62b7054e254d0/Absolute_Vorticity.zip b/dev/_downloads/fbe57406f64b85e1cff62b7054e254d0/Absolute_Vorticity.zip index 4e35e147661..f5becac9716 100644 Binary files a/dev/_downloads/fbe57406f64b85e1cff62b7054e254d0/Absolute_Vorticity.zip and b/dev/_downloads/fbe57406f64b85e1cff62b7054e254d0/Absolute_Vorticity.zip differ diff --git a/dev/_downloads/ff38f4d47a1d9e53439d712fc374a7b4/Find_Natural_Neighbors_Verification.zip b/dev/_downloads/ff38f4d47a1d9e53439d712fc374a7b4/Find_Natural_Neighbors_Verification.zip index 82aa492a499..cae428b7e4b 100644 Binary files a/dev/_downloads/ff38f4d47a1d9e53439d712fc374a7b4/Find_Natural_Neighbors_Verification.zip and b/dev/_downloads/ff38f4d47a1d9e53439d712fc374a7b4/Find_Natural_Neighbors_Verification.zip differ diff --git a/dev/_images/NSF-Unidata_lockup_horizontal_2024.png b/dev/_images/NSF-Unidata_lockup_horizontal_2024.png new file mode 100644 index 00000000000..37e1a452ed9 Binary files /dev/null and b/dev/_images/NSF-Unidata_lockup_horizontal_2024.png differ diff --git a/dev/_images/NSF.jpg b/dev/_images/NSF.jpg deleted file mode 100644 index 4153620c45b..00000000000 Binary files a/dev/_images/NSF.jpg and /dev/null differ diff --git a/dev/_images/metpy-plots-ctables-1.png b/dev/_images/metpy-plots-ctables-1.png index e8d14507567..247e124ec6b 100644 Binary files a/dev/_images/metpy-plots-ctables-1.png and b/dev/_images/metpy-plots-ctables-1.png differ diff --git a/dev/_images/sphx_glr_sigma_to_pressure_interpolation_001.png b/dev/_images/sphx_glr_sigma_to_pressure_interpolation_001.png index f82e5d936b3..cb049ab4177 100644 Binary files a/dev/_images/sphx_glr_sigma_to_pressure_interpolation_001.png and b/dev/_images/sphx_glr_sigma_to_pressure_interpolation_001.png differ diff --git a/dev/_images/sphx_glr_sigma_to_pressure_interpolation_thumb.png b/dev/_images/sphx_glr_sigma_to_pressure_interpolation_thumb.png index 267285061da..45eb68e3720 100644 Binary files a/dev/_images/sphx_glr_sigma_to_pressure_interpolation_thumb.png and b/dev/_images/sphx_glr_sigma_to_pressure_interpolation_thumb.png differ diff --git a/dev/_images/unidata_150x150.png b/dev/_images/unidata_150x150.png deleted file mode 100644 index 9ddd2bea04e..00000000000 Binary files a/dev/_images/unidata_150x150.png and /dev/null differ diff --git a/dev/_sources/examples/Advanced_Sounding.rst.txt b/dev/_sources/examples/Advanced_Sounding.rst.txt index a14b0d9d6dc..545f3ab5fd6 100644 --- a/dev/_sources/examples/Advanced_Sounding.rst.txt +++ b/dev/_sources/examples/Advanced_Sounding.rst.txt @@ -165,7 +165,7 @@ Create a new figure. The dimensions here give a good aspect ratio. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.172 seconds) + **Total running time of the script:** (0 minutes 0.165 seconds) .. _sphx_glr_download_examples_Advanced_Sounding.py: diff --git a/dev/_sources/examples/Advanced_Sounding_With_Complex_Layout.rst.txt b/dev/_sources/examples/Advanced_Sounding_With_Complex_Layout.rst.txt index 96017c93ef7..fb0ba1caea3 100644 --- a/dev/_sources/examples/Advanced_Sounding_With_Complex_Layout.rst.txt +++ b/dev/_sources/examples/Advanced_Sounding_With_Complex_Layout.rst.txt @@ -143,7 +143,7 @@ Create a new figure. The dimensions here give a good aspect ratio .. code-block:: none - [] + [] @@ -429,7 +429,7 @@ try another Skew-T with a few more advanced features: .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.679 seconds) + **Total running time of the script:** (0 minutes 0.639 seconds) .. _sphx_glr_download_examples_Advanced_Sounding_With_Complex_Layout.py: diff --git a/dev/_sources/examples/Four_Panel_Map.rst.txt b/dev/_sources/examples/Four_Panel_Map.rst.txt index fb5906a43e3..343db975b80 100644 --- a/dev/_sources/examples/Four_Panel_Map.rst.txt +++ b/dev/_sources/examples/Four_Panel_Map.rst.txt @@ -259,7 +259,7 @@ By reading model output data from a netCDF file, we can create a four panel plot .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 8.348 seconds) + **Total running time of the script:** (0 minutes 8.162 seconds) .. _sphx_glr_download_examples_Four_Panel_Map.py: diff --git a/dev/_sources/examples/XArray_Projections.rst.txt b/dev/_sources/examples/XArray_Projections.rst.txt index c822f154ec2..27c059090ce 100644 --- a/dev/_sources/examples/XArray_Projections.rst.txt +++ b/dev/_sources/examples/XArray_Projections.rst.txt @@ -68,7 +68,7 @@ data on a map using CartoPy. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 8.942 seconds) + **Total running time of the script:** (0 minutes 8.768 seconds) .. _sphx_glr_download_examples_XArray_Projections.py: diff --git a/dev/_sources/examples/calculations/Absolute_Vorticity.rst.txt b/dev/_sources/examples/calculations/Absolute_Vorticity.rst.txt index 806354e3b06..536fbce2eda 100644 --- a/dev/_sources/examples/calculations/Absolute_Vorticity.rst.txt +++ b/dev/_sources/examples/calculations/Absolute_Vorticity.rst.txt @@ -68,7 +68,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.138 seconds) + **Total running time of the script:** (0 minutes 0.133 seconds) .. _sphx_glr_download_examples_calculations_Absolute_Vorticity.py: diff --git a/dev/_sources/examples/calculations/Advection.rst.txt b/dev/_sources/examples/calculations/Advection.rst.txt index f740fd72d44..73fc2ee0f49 100644 --- a/dev/_sources/examples/calculations/Advection.rst.txt +++ b/dev/_sources/examples/calculations/Advection.rst.txt @@ -91,7 +91,7 @@ the example xarray Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.114 seconds) + **Total running time of the script:** (0 minutes 0.110 seconds) .. _sphx_glr_download_examples_calculations_Advection.py: diff --git a/dev/_sources/examples/calculations/Divergence.rst.txt b/dev/_sources/examples/calculations/Divergence.rst.txt index 34775efafa4..c36827f51ee 100644 --- a/dev/_sources/examples/calculations/Divergence.rst.txt +++ b/dev/_sources/examples/calculations/Divergence.rst.txt @@ -68,7 +68,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.122 seconds) + **Total running time of the script:** (0 minutes 0.116 seconds) .. _sphx_glr_download_examples_calculations_Divergence.py: diff --git a/dev/_sources/examples/calculations/Equivalent_Potential_Temperature.rst.txt b/dev/_sources/examples/calculations/Equivalent_Potential_Temperature.rst.txt index 380be4fec05..1e73808f9ca 100644 --- a/dev/_sources/examples/calculations/Equivalent_Potential_Temperature.rst.txt +++ b/dev/_sources/examples/calculations/Equivalent_Potential_Temperature.rst.txt @@ -168,7 +168,7 @@ Use the layer defined above and plot the equivalent potential temperature .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.073 seconds) + **Total running time of the script:** (0 minutes 0.070 seconds) .. _sphx_glr_download_examples_calculations_Equivalent_Potential_Temperature.py: diff --git a/dev/_sources/examples/calculations/Mean_Pressure_Weighted.rst.txt b/dev/_sources/examples/calculations/Mean_Pressure_Weighted.rst.txt index 0ba77511d8b..2325715e069 100644 --- a/dev/_sources/examples/calculations/Mean_Pressure_Weighted.rst.txt +++ b/dev/_sources/examples/calculations/Mean_Pressure_Weighted.rst.txt @@ -130,7 +130,7 @@ Calculate the mean pressure weighted temperature over a depth of 500 hPa .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.010 seconds) + **Total running time of the script:** (0 minutes 0.009 seconds) .. _sphx_glr_download_examples_calculations_Mean_Pressure_Weighted.py: diff --git a/dev/_sources/examples/calculations/QVector.rst.txt b/dev/_sources/examples/calculations/QVector.rst.txt index 2b9fd8c4a0e..3f4fd7adf3d 100644 --- a/dev/_sources/examples/calculations/QVector.rst.txt +++ b/dev/_sources/examples/calculations/QVector.rst.txt @@ -97,7 +97,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.141 seconds) + **Total running time of the script:** (0 minutes 0.136 seconds) .. _sphx_glr_download_examples_calculations_QVector.py: diff --git a/dev/_sources/examples/calculations/Shearing_Deformation.rst.txt b/dev/_sources/examples/calculations/Shearing_Deformation.rst.txt index a6637a87909..76eb103097b 100644 --- a/dev/_sources/examples/calculations/Shearing_Deformation.rst.txt +++ b/dev/_sources/examples/calculations/Shearing_Deformation.rst.txt @@ -68,7 +68,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.136 seconds) + **Total running time of the script:** (0 minutes 0.131 seconds) .. _sphx_glr_download_examples_calculations_Shearing_Deformation.py: diff --git a/dev/_sources/examples/calculations/Smoothing.rst.txt b/dev/_sources/examples/calculations/Smoothing.rst.txt index c824cb9cf8b..ef3d0472eb5 100644 --- a/dev/_sources/examples/calculations/Smoothing.rst.txt +++ b/dev/_sources/examples/calculations/Smoothing.rst.txt @@ -140,7 +140,7 @@ Now, create a grid showing different smoothing options .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.521 seconds) + **Total running time of the script:** (0 minutes 0.508 seconds) .. _sphx_glr_download_examples_calculations_Smoothing.py: diff --git a/dev/_sources/examples/calculations/Sounding_Calculations.rst.txt b/dev/_sources/examples/calculations/Sounding_Calculations.rst.txt index caf725de62f..20153b29c1c 100644 --- a/dev/_sources/examples/calculations/Sounding_Calculations.rst.txt +++ b/dev/_sources/examples/calculations/Sounding_Calculations.rst.txt @@ -480,7 +480,7 @@ Print Important Sounding Parameters .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.247 seconds) + **Total running time of the script:** (0 minutes 0.237 seconds) .. _sphx_glr_download_examples_calculations_Sounding_Calculations.py: diff --git a/dev/_sources/examples/calculations/Stretching_Deformation.rst.txt b/dev/_sources/examples/calculations/Stretching_Deformation.rst.txt index ffbcc061320..3b2d3fdb821 100644 --- a/dev/_sources/examples/calculations/Stretching_Deformation.rst.txt +++ b/dev/_sources/examples/calculations/Stretching_Deformation.rst.txt @@ -68,7 +68,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.134 seconds) + **Total running time of the script:** (0 minutes 0.131 seconds) .. _sphx_glr_download_examples_calculations_Stretching_Deformation.py: diff --git a/dev/_sources/examples/calculations/Total_Deformation.rst.txt b/dev/_sources/examples/calculations/Total_Deformation.rst.txt index 4d6653125b2..1985ecd887f 100644 --- a/dev/_sources/examples/calculations/Total_Deformation.rst.txt +++ b/dev/_sources/examples/calculations/Total_Deformation.rst.txt @@ -68,7 +68,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.139 seconds) + **Total running time of the script:** (0 minutes 0.132 seconds) .. _sphx_glr_download_examples_calculations_Total_Deformation.py: diff --git a/dev/_sources/examples/calculations/Vorticity.rst.txt b/dev/_sources/examples/calculations/Vorticity.rst.txt index fc04161c11b..08049233869 100644 --- a/dev/_sources/examples/calculations/Vorticity.rst.txt +++ b/dev/_sources/examples/calculations/Vorticity.rst.txt @@ -68,7 +68,7 @@ Dataset and plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.137 seconds) + **Total running time of the script:** (0 minutes 0.132 seconds) .. _sphx_glr_download_examples_calculations_Vorticity.py: diff --git a/dev/_sources/examples/calculations/Wind_Speed.rst.txt b/dev/_sources/examples/calculations/Wind_Speed.rst.txt index 5b81267bc0a..358d9e804e8 100644 --- a/dev/_sources/examples/calculations/Wind_Speed.rst.txt +++ b/dev/_sources/examples/calculations/Wind_Speed.rst.txt @@ -68,7 +68,7 @@ plotting using Matplotlib. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.113 seconds) + **Total running time of the script:** (0 minutes 0.106 seconds) .. _sphx_glr_download_examples_calculations_Wind_Speed.py: diff --git a/dev/_sources/examples/calculations/sg_execution_times.rst.txt b/dev/_sources/examples/calculations/sg_execution_times.rst.txt index 20e9ab75254..0a975d99f36 100644 --- a/dev/_sources/examples/calculations/sg_execution_times.rst.txt +++ b/dev/_sources/examples/calculations/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**00:02.081** total execution time for 21 files **from examples/calculations**: +**00:02.007** total execution time for 21 files **from examples/calculations**: .. container:: @@ -33,52 +33,52 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_calculations_Smoothing.py` (``Smoothing.py``) - - 00:00.521 + - 00:00.508 - 0.0 * - :ref:`sphx_glr_examples_calculations_Sounding_Calculations.py` (``Sounding_Calculations.py``) - - 00:00.247 + - 00:00.237 - 0.0 * - :ref:`sphx_glr_examples_calculations_QVector.py` (``QVector.py``) - - 00:00.141 - - 0.0 - * - :ref:`sphx_glr_examples_calculations_Total_Deformation.py` (``Total_Deformation.py``) - - 00:00.139 + - 00:00.136 - 0.0 * - :ref:`sphx_glr_examples_calculations_Absolute_Vorticity.py` (``Absolute_Vorticity.py``) - - 00:00.138 + - 00:00.133 + - 0.0 + * - :ref:`sphx_glr_examples_calculations_Total_Deformation.py` (``Total_Deformation.py``) + - 00:00.132 - 0.0 * - :ref:`sphx_glr_examples_calculations_Vorticity.py` (``Vorticity.py``) - - 00:00.137 + - 00:00.132 - 0.0 * - :ref:`sphx_glr_examples_calculations_Shearing_Deformation.py` (``Shearing_Deformation.py``) - - 00:00.136 + - 00:00.131 - 0.0 * - :ref:`sphx_glr_examples_calculations_Stretching_Deformation.py` (``Stretching_Deformation.py``) - - 00:00.134 + - 00:00.131 - 0.0 * - :ref:`sphx_glr_examples_calculations_Divergence.py` (``Divergence.py``) - - 00:00.122 + - 00:00.116 - 0.0 * - :ref:`sphx_glr_examples_calculations_Advection.py` (``Advection.py``) - - 00:00.114 + - 00:00.110 - 0.0 * - :ref:`sphx_glr_examples_calculations_Wind_Speed.py` (``Wind_Speed.py``) - - 00:00.113 + - 00:00.106 - 0.0 * - :ref:`sphx_glr_examples_calculations_Equivalent_Potential_Temperature.py` (``Equivalent_Potential_Temperature.py``) - - 00:00.073 + - 00:00.070 - 0.0 * - :ref:`sphx_glr_examples_calculations_Gradient.py` (``Gradient.py``) - 00:00.013 - 0.0 - * - :ref:`sphx_glr_examples_calculations_Thickness_Hydrostatic.py` (``Thickness_Hydrostatic.py``) + * - :ref:`sphx_glr_examples_calculations_Bulk_Shear.py` (``Bulk_Shear.py``) - 00:00.010 - 0.0 - * - :ref:`sphx_glr_examples_calculations_Bulk_Shear.py` (``Bulk_Shear.py``) + * - :ref:`sphx_glr_examples_calculations_Thickness_Hydrostatic.py` (``Thickness_Hydrostatic.py``) - 00:00.010 - 0.0 * - :ref:`sphx_glr_examples_calculations_Mean_Pressure_Weighted.py` (``Mean_Pressure_Weighted.py``) - - 00:00.010 + - 00:00.009 - 0.0 * - :ref:`sphx_glr_examples_calculations_Static_Stability.py` (``Static_Stability.py``) - 00:00.008 diff --git a/dev/_sources/examples/cross_section.rst.txt b/dev/_sources/examples/cross_section.rst.txt index 870aae02e26..fb9042d49ec 100644 --- a/dev/_sources/examples/cross_section.rst.txt +++ b/dev/_sources/examples/cross_section.rst.txt @@ -349,7 +349,7 @@ to ``ax.set_xticklabels`` to label lat/lon pairs, similar to the default NCL out .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 4.449 seconds) + **Total running time of the script:** (0 minutes 4.413 seconds) .. _sphx_glr_download_examples_cross_section.py: diff --git a/dev/_sources/examples/formats/GINI_Water_Vapor.rst.txt b/dev/_sources/examples/formats/GINI_Water_Vapor.rst.txt index 134367f4d71..c65300c2e45 100644 --- a/dev/_sources/examples/formats/GINI_Water_Vapor.rst.txt +++ b/dev/_sources/examples/formats/GINI_Water_Vapor.rst.txt @@ -133,7 +133,7 @@ the projection information. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.892 seconds) + **Total running time of the script:** (0 minutes 0.856 seconds) .. _sphx_glr_download_examples_formats_GINI_Water_Vapor.py: diff --git a/dev/_sources/examples/formats/NEXRAD_Level_2_File.rst.txt b/dev/_sources/examples/formats/NEXRAD_Level_2_File.rst.txt index 30a038eef9b..87e64fb7294 100644 --- a/dev/_sources/examples/formats/NEXRAD_Level_2_File.rst.txt +++ b/dev/_sources/examples/formats/NEXRAD_Level_2_File.rst.txt @@ -194,7 +194,7 @@ Calculate ranges for the gates from the metadata .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 5.089 seconds) + **Total running time of the script:** (0 minutes 4.968 seconds) .. _sphx_glr_download_examples_formats_NEXRAD_Level_2_File.py: diff --git a/dev/_sources/examples/formats/NEXRAD_Level_3_File.rst.txt b/dev/_sources/examples/formats/NEXRAD_Level_3_File.rst.txt index 3e0781a322e..50594c71490 100644 --- a/dev/_sources/examples/formats/NEXRAD_Level_3_File.rst.txt +++ b/dev/_sources/examples/formats/NEXRAD_Level_3_File.rst.txt @@ -105,7 +105,7 @@ Use MetPy to read information from a NEXRAD Level 3 (NIDS product) file and plot .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 1.537 seconds) + **Total running time of the script:** (0 minutes 1.506 seconds) .. _sphx_glr_download_examples_formats_NEXRAD_Level_3_File.py: diff --git a/dev/_sources/examples/formats/sg_execution_times.rst.txt b/dev/_sources/examples/formats/sg_execution_times.rst.txt index 5825e65260f..70b87d51cce 100644 --- a/dev/_sources/examples/formats/sg_execution_times.rst.txt +++ b/dev/_sources/examples/formats/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**00:07.518** total execution time for 3 files **from examples/formats**: +**00:07.329** total execution time for 3 files **from examples/formats**: .. container:: @@ -33,11 +33,11 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_formats_NEXRAD_Level_2_File.py` (``NEXRAD_Level_2_File.py``) - - 00:05.089 + - 00:04.968 - 0.0 * - :ref:`sphx_glr_examples_formats_NEXRAD_Level_3_File.py` (``NEXRAD_Level_3_File.py``) - - 00:01.537 + - 00:01.506 - 0.0 * - :ref:`sphx_glr_examples_formats_GINI_Water_Vapor.py` (``GINI_Water_Vapor.py``) - - 00:00.892 + - 00:00.856 - 0.0 diff --git a/dev/_sources/examples/gridding/Find_Natural_Neighbors_Verification.rst.txt b/dev/_sources/examples/gridding/Find_Natural_Neighbors_Verification.rst.txt index 6887bbbf3d2..d716ea9f250 100644 --- a/dev/_sources/examples/gridding/Find_Natural_Neighbors_Verification.rst.txt +++ b/dev/_sources/examples/gridding/Find_Natural_Neighbors_Verification.rst.txt @@ -139,7 +139,7 @@ We can plot all of the triangles as well as the circles representing the circumc .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.292 seconds) + **Total running time of the script:** (0 minutes 0.284 seconds) .. _sphx_glr_download_examples_gridding_Find_Natural_Neighbors_Verification.py: diff --git a/dev/_sources/examples/gridding/Inverse_Distance_Verification.rst.txt b/dev/_sources/examples/gridding/Inverse_Distance_Verification.rst.txt index 4c49888670d..9e567ae070f 100644 --- a/dev/_sources/examples/gridding/Inverse_Distance_Verification.rst.txt +++ b/dev/_sources/examples/gridding/Inverse_Distance_Verification.rst.txt @@ -207,7 +207,7 @@ Plot all of the affiliated information and interpolation values. .. code-block:: none - + @@ -369,7 +369,7 @@ Step through barnes calculations. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.344 seconds) + **Total running time of the script:** (0 minutes 0.335 seconds) .. _sphx_glr_download_examples_gridding_Inverse_Distance_Verification.py: diff --git a/dev/_sources/examples/gridding/Natural_Neighbor_Verification.rst.txt b/dev/_sources/examples/gridding/Natural_Neighbor_Verification.rst.txt index 9bcd850eda1..5b5d95fc439 100644 --- a/dev/_sources/examples/gridding/Natural_Neighbor_Verification.rst.txt +++ b/dev/_sources/examples/gridding/Natural_Neighbor_Verification.rst.txt @@ -212,7 +212,7 @@ examine the results to see if they are correct. .. code-block:: none - + @@ -485,7 +485,7 @@ the above visual example to the 3rd decimal place. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.413 seconds) + **Total running time of the script:** (0 minutes 0.402 seconds) .. _sphx_glr_download_examples_gridding_Natural_Neighbor_Verification.py: diff --git a/dev/_sources/examples/gridding/Point_Interpolation.rst.txt b/dev/_sources/examples/gridding/Point_Interpolation.rst.txt index 9dbf142cd64..33f8ef22a55 100644 --- a/dev/_sources/examples/gridding/Point_Interpolation.rst.txt +++ b/dev/_sources/examples/gridding/Point_Interpolation.rst.txt @@ -139,7 +139,7 @@ Scipy.interpolate linear .. code-block:: none - + @@ -173,7 +173,7 @@ Natural neighbor interpolation (MetPy implementation) .. code-block:: none - + @@ -212,7 +212,7 @@ min_neighbors = 1 .. code-block:: none - + @@ -249,7 +249,7 @@ min_neighbors = 3 .. code-block:: none - + @@ -286,7 +286,7 @@ linear .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 3.864 seconds) + **Total running time of the script:** (0 minutes 3.724 seconds) .. _sphx_glr_download_examples_gridding_Point_Interpolation.py: diff --git a/dev/_sources/examples/gridding/Wind_SLP_Interpolation.rst.txt b/dev/_sources/examples/gridding/Wind_SLP_Interpolation.rst.txt index ab48a547600..8ee19721abe 100644 --- a/dev/_sources/examples/gridding/Wind_SLP_Interpolation.rst.txt +++ b/dev/_sources/examples/gridding/Wind_SLP_Interpolation.rst.txt @@ -256,7 +256,7 @@ Set up the map and plot the interpolated grids appropriately. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 11.862 seconds) + **Total running time of the script:** (0 minutes 11.608 seconds) .. _sphx_glr_download_examples_gridding_Wind_SLP_Interpolation.py: diff --git a/dev/_sources/examples/gridding/sg_execution_times.rst.txt b/dev/_sources/examples/gridding/sg_execution_times.rst.txt index 78d37543baf..ccdfc1b48e5 100644 --- a/dev/_sources/examples/gridding/sg_execution_times.rst.txt +++ b/dev/_sources/examples/gridding/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**00:16.775** total execution time for 5 files **from examples/gridding**: +**00:16.351** total execution time for 5 files **from examples/gridding**: .. container:: @@ -33,17 +33,17 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_gridding_Wind_SLP_Interpolation.py` (``Wind_SLP_Interpolation.py``) - - 00:11.862 + - 00:11.608 - 0.0 * - :ref:`sphx_glr_examples_gridding_Point_Interpolation.py` (``Point_Interpolation.py``) - - 00:03.864 + - 00:03.724 - 0.0 * - :ref:`sphx_glr_examples_gridding_Natural_Neighbor_Verification.py` (``Natural_Neighbor_Verification.py``) - - 00:00.413 + - 00:00.402 - 0.0 * - :ref:`sphx_glr_examples_gridding_Inverse_Distance_Verification.py` (``Inverse_Distance_Verification.py``) - - 00:00.344 + - 00:00.335 - 0.0 * - :ref:`sphx_glr_examples_gridding_Find_Natural_Neighbors_Verification.py` (``Find_Natural_Neighbors_Verification.py``) - - 00:00.292 + - 00:00.284 - 0.0 diff --git a/dev/_sources/examples/isentropic_example.rst.txt b/dev/_sources/examples/isentropic_example.rst.txt index f8ec14155ce..5b66b01fa4a 100644 --- a/dev/_sources/examples/isentropic_example.rst.txt +++ b/dev/_sources/examples/isentropic_example.rst.txt @@ -569,7 +569,7 @@ The output is an xarray Dataset: u_wind (isentropic_level, y, x) float64 276kB <Quantity([[[... v_wind (isentropic_level, y, x) float64 276kB <Quantity([[[... Specific_humidity (isentropic_level, y, x) float64 276kB <Quantity([[[... - Geopotential_height (isentropic_level, y, x) float64 276kB <Quantity([[[...


    • @@ -804,7 +804,7 @@ calculated with `mpcalc.montgomery_streamfunction`. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 10.121 seconds) + **Total running time of the script:** (0 minutes 9.675 seconds) .. _sphx_glr_download_examples_isentropic_example.py: diff --git a/dev/_sources/examples/meteogram_metpy.rst.txt b/dev/_sources/examples/meteogram_metpy.rst.txt index a65aa937c76..8abc71d176b 100644 --- a/dev/_sources/examples/meteogram_metpy.rst.txt +++ b/dev/_sources/examples/meteogram_metpy.rst.txt @@ -253,7 +253,7 @@ Plots time series data as a meteogram. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.552 seconds) + **Total running time of the script:** (0 minutes 0.531 seconds) .. _sphx_glr_download_examples_meteogram_metpy.py: diff --git a/dev/_sources/examples/plots/Combined_plotting.rst.txt b/dev/_sources/examples/plots/Combined_plotting.rst.txt index fb2edb2a508..539d8ab1d45 100644 --- a/dev/_sources/examples/plots/Combined_plotting.rst.txt +++ b/dev/_sources/examples/plots/Combined_plotting.rst.txt @@ -123,7 +123,7 @@ Plot the data on a map .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 6.094 seconds) + **Total running time of the script:** (0 minutes 6.017 seconds) .. _sphx_glr_download_examples_plots_Combined_plotting.py: diff --git a/dev/_sources/examples/plots/Hodograph_Inset.rst.txt b/dev/_sources/examples/plots/Hodograph_Inset.rst.txt index 773b9ab3348..8d5249c98b9 100644 --- a/dev/_sources/examples/plots/Hodograph_Inset.rst.txt +++ b/dev/_sources/examples/plots/Hodograph_Inset.rst.txt @@ -146,7 +146,7 @@ assign units. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.206 seconds) + **Total running time of the script:** (0 minutes 0.200 seconds) .. _sphx_glr_download_examples_plots_Hodograph_Inset.py: diff --git a/dev/_sources/examples/plots/Mesonet_Stationplot.rst.txt b/dev/_sources/examples/plots/Mesonet_Stationplot.rst.txt index 43e00a771a5..42f7a8a611f 100644 --- a/dev/_sources/examples/plots/Mesonet_Stationplot.rst.txt +++ b/dev/_sources/examples/plots/Mesonet_Stationplot.rst.txt @@ -193,7 +193,7 @@ Create the figure .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 13.848 seconds) + **Total running time of the script:** (0 minutes 13.357 seconds) .. _sphx_glr_download_examples_plots_Mesonet_Stationplot.py: diff --git a/dev/_sources/examples/plots/Plotting_Surface_Analysis.rst.txt b/dev/_sources/examples/plots/Plotting_Surface_Analysis.rst.txt index 5c68370588e..f13a7e0b9a2 100644 --- a/dev/_sources/examples/plots/Plotting_Surface_Analysis.rst.txt +++ b/dev/_sources/examples/plots/Plotting_Surface_Analysis.rst.txt @@ -137,7 +137,7 @@ Set up the map for plotting, parse the bulletin, and plot it .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 6.245 seconds) + **Total running time of the script:** (0 minutes 6.202 seconds) .. _sphx_glr_download_examples_plots_Plotting_Surface_Analysis.py: diff --git a/dev/_sources/examples/plots/Simple_Fronts_Plot.rst.txt b/dev/_sources/examples/plots/Simple_Fronts_Plot.rst.txt index 132d4b9e50c..52c137fd8ff 100644 --- a/dev/_sources/examples/plots/Simple_Fronts_Plot.rst.txt +++ b/dev/_sources/examples/plots/Simple_Fronts_Plot.rst.txt @@ -94,7 +94,7 @@ standard lines, but add our path effects. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.098 seconds) + **Total running time of the script:** (0 minutes 0.097 seconds) .. _sphx_glr_download_examples_plots_Simple_Fronts_Plot.py: diff --git a/dev/_sources/examples/plots/Simple_Sounding.rst.txt b/dev/_sources/examples/plots/Simple_Sounding.rst.txt index 136ab76e7c9..c02945750d3 100644 --- a/dev/_sources/examples/plots/Simple_Sounding.rst.txt +++ b/dev/_sources/examples/plots/Simple_Sounding.rst.txt @@ -149,7 +149,7 @@ assign units. .. code-block:: none - + @@ -206,7 +206,7 @@ assign units. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.300 seconds) + **Total running time of the script:** (0 minutes 0.293 seconds) .. _sphx_glr_download_examples_plots_Simple_Sounding.py: diff --git a/dev/_sources/examples/plots/Simplified_Image_Plot.rst.txt b/dev/_sources/examples/plots/Simplified_Image_Plot.rst.txt index 8d4dd07c82c..2da91567a2e 100644 --- a/dev/_sources/examples/plots/Simplified_Image_Plot.rst.txt +++ b/dev/_sources/examples/plots/Simplified_Image_Plot.rst.txt @@ -75,7 +75,7 @@ Plots a sample satellite image file. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.517 seconds) + **Total running time of the script:** (0 minutes 0.491 seconds) .. _sphx_glr_download_examples_plots_Simplified_Image_Plot.py: diff --git a/dev/_sources/examples/plots/Skew-T_Layout.rst.txt b/dev/_sources/examples/plots/Skew-T_Layout.rst.txt index 9ba9b8d010f..eca3be78f3c 100644 --- a/dev/_sources/examples/plots/Skew-T_Layout.rst.txt +++ b/dev/_sources/examples/plots/Skew-T_Layout.rst.txt @@ -146,7 +146,7 @@ assign units. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.198 seconds) + **Total running time of the script:** (0 minutes 0.194 seconds) .. _sphx_glr_download_examples_plots_Skew-T_Layout.py: diff --git a/dev/_sources/examples/plots/Sounding_LCL_Dataset.rst.txt b/dev/_sources/examples/plots/Sounding_LCL_Dataset.rst.txt index 1770c798cdd..f401e88743d 100644 --- a/dev/_sources/examples/plots/Sounding_LCL_Dataset.rst.txt +++ b/dev/_sources/examples/plots/Sounding_LCL_Dataset.rst.txt @@ -160,7 +160,7 @@ assign units. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.180 seconds) + **Total running time of the script:** (0 minutes 0.176 seconds) .. _sphx_glr_download_examples_plots_Sounding_LCL_Dataset.py: diff --git a/dev/_sources/examples/plots/Station_Plot.rst.txt b/dev/_sources/examples/plots/Station_Plot.rst.txt index 297b6797b57..31be8c34f6d 100644 --- a/dev/_sources/examples/plots/Station_Plot.rst.txt +++ b/dev/_sources/examples/plots/Station_Plot.rst.txt @@ -184,7 +184,7 @@ The payoff .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 13.231 seconds) + **Total running time of the script:** (0 minutes 12.901 seconds) .. _sphx_glr_download_examples_plots_Station_Plot.py: diff --git a/dev/_sources/examples/plots/Station_Plot_with_Layout.rst.txt b/dev/_sources/examples/plots/Station_Plot_with_Layout.rst.txt index 0ed420cc8fd..563a4f76d7e 100644 --- a/dev/_sources/examples/plots/Station_Plot_with_Layout.rst.txt +++ b/dev/_sources/examples/plots/Station_Plot_with_Layout.rst.txt @@ -333,7 +333,7 @@ or instead, a custom layout can be used: .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 1.502 seconds) + **Total running time of the script:** (0 minutes 1.469 seconds) .. _sphx_glr_download_examples_plots_Station_Plot_with_Layout.py: diff --git a/dev/_sources/examples/plots/US_Counties.rst.txt b/dev/_sources/examples/plots/US_Counties.rst.txt index 63fae178751..07b6f16cede 100644 --- a/dev/_sources/examples/plots/US_Counties.rst.txt +++ b/dev/_sources/examples/plots/US_Counties.rst.txt @@ -70,7 +70,7 @@ Demonstrate how to plot US counties at all three available resolutions. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 2.258 seconds) + **Total running time of the script:** (0 minutes 2.203 seconds) .. _sphx_glr_download_examples_plots_US_Counties.py: diff --git a/dev/_sources/examples/plots/nhc_wind_probabilities.rst.txt b/dev/_sources/examples/plots/nhc_wind_probabilities.rst.txt index 02cb6345bb8..a07e288b12b 100644 --- a/dev/_sources/examples/plots/nhc_wind_probabilities.rst.txt +++ b/dev/_sources/examples/plots/nhc_wind_probabilities.rst.txt @@ -65,7 +65,7 @@ Read in the shapefile file containing the wind probabilities. .. code-block:: none - /opt/hostedtoolcache/Python/3.11.10/x64/lib/python3.11/site-packages/pyogrio/geopandas.py:265: UserWarning: More than one layer found in 'pyogrio_7748479a829d45eaa645496118dfaac9.zip': '2021082012_wsp34knt120hr_5km' (default), '2021082012_wsp50knt120hr_5km', '2021082012_wsp64knt120hr_5km'. Specify layer parameter to avoid this warning. + /opt/hostedtoolcache/Python/3.11.10/x64/lib/python3.11/site-packages/pyogrio/geopandas.py:265: UserWarning: More than one layer found in 'pyogrio_080bfd10af6f41818c69fb4a29f77827.zip': '2021082012_wsp34knt120hr_5km' (default), '2021082012_wsp50knt120hr_5km', '2021082012_wsp64knt120hr_5km'. Specify layer parameter to avoid this warning. result = read_func( @@ -704,7 +704,7 @@ wind speed probabilities, along with some select cities and their specific proba .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 6.592 seconds) + **Total running time of the script:** (0 minutes 6.404 seconds) .. _sphx_glr_download_examples_plots_nhc_wind_probabilities.py: diff --git a/dev/_sources/examples/plots/raster_declarative.rst.txt b/dev/_sources/examples/plots/raster_declarative.rst.txt index 9f4e41633d5..2ea7df22fdc 100644 --- a/dev/_sources/examples/plots/raster_declarative.rst.txt +++ b/dev/_sources/examples/plots/raster_declarative.rst.txt @@ -476,9 +476,9 @@ Preview the data: file_format: GRIB-1 location: /nomads3_data/raid2/noaaport/merged/narr/198704... _CoordinateModelRunDate: 1987-04-04T18:00:00Z - History: Translated to CF-1.0 Conventions by Netcdf-Java...
    @@ -592,7 +592,7 @@ Add the plot to a Map Panel and Panel Container. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.784 seconds) + **Total running time of the script:** (0 minutes 0.745 seconds) .. _sphx_glr_download_examples_plots_raster_declarative.py: diff --git a/dev/_sources/examples/plots/sg_execution_times.rst.txt b/dev/_sources/examples/plots/sg_execution_times.rst.txt index ebbe5b76784..d3c9e603ff3 100644 --- a/dev/_sources/examples/plots/sg_execution_times.rst.txt +++ b/dev/_sources/examples/plots/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**01:01.735** total execution time for 17 files **from examples/plots**: +**01:00.054** total execution time for 17 files **from examples/plots**: .. container:: @@ -33,53 +33,53 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_plots_Mesonet_Stationplot.py` (``Mesonet_Stationplot.py``) - - 00:13.848 + - 00:13.357 - 0.0 * - :ref:`sphx_glr_examples_plots_Station_Plot.py` (``Station_Plot.py``) - - 00:13.231 + - 00:12.901 - 0.0 * - :ref:`sphx_glr_examples_plots_spc_convective_outlook.py` (``spc_convective_outlook.py``) - - 00:07.844 + - 00:07.500 - 0.0 * - :ref:`sphx_glr_examples_plots_nhc_wind_probabilities.py` (``nhc_wind_probabilities.py``) - - 00:06.592 + - 00:06.404 - 0.0 * - :ref:`sphx_glr_examples_plots_Plotting_Surface_Analysis.py` (``Plotting_Surface_Analysis.py``) - - 00:06.245 + - 00:06.202 - 0.0 * - :ref:`sphx_glr_examples_plots_Combined_plotting.py` (``Combined_plotting.py``) - - 00:06.094 + - 00:06.017 - 0.0 * - :ref:`sphx_glr_examples_plots_US_Counties.py` (``US_Counties.py``) - - 00:02.258 + - 00:02.203 - 0.0 * - :ref:`sphx_glr_examples_plots_Station_Plot_with_Layout.py` (``Station_Plot_with_Layout.py``) - - 00:01.502 + - 00:01.469 - 0.0 * - :ref:`sphx_glr_examples_plots_surface_declarative.py` (``surface_declarative.py``) - - 00:01.117 + - 00:01.097 - 0.0 * - :ref:`sphx_glr_examples_plots_raster_declarative.py` (``raster_declarative.py``) - - 00:00.784 + - 00:00.745 - 0.0 * - :ref:`sphx_glr_examples_plots_upperair_declarative.py` (``upperair_declarative.py``) - - 00:00.719 + - 00:00.710 - 0.0 * - :ref:`sphx_glr_examples_plots_Simplified_Image_Plot.py` (``Simplified_Image_Plot.py``) - - 00:00.517 + - 00:00.491 - 0.0 * - :ref:`sphx_glr_examples_plots_Simple_Sounding.py` (``Simple_Sounding.py``) - - 00:00.300 + - 00:00.293 - 0.0 * - :ref:`sphx_glr_examples_plots_Hodograph_Inset.py` (``Hodograph_Inset.py``) - - 00:00.206 + - 00:00.200 - 0.0 * - :ref:`sphx_glr_examples_plots_Skew-T_Layout.py` (``Skew-T_Layout.py``) - - 00:00.198 + - 00:00.194 - 0.0 * - :ref:`sphx_glr_examples_plots_Sounding_LCL_Dataset.py` (``Sounding_LCL_Dataset.py``) - - 00:00.180 + - 00:00.176 - 0.0 * - :ref:`sphx_glr_examples_plots_Simple_Fronts_Plot.py` (``Simple_Fronts_Plot.py``) - - 00:00.098 + - 00:00.097 - 0.0 diff --git a/dev/_sources/examples/plots/spc_convective_outlook.rst.txt b/dev/_sources/examples/plots/spc_convective_outlook.rst.txt index 93e73afd48a..a9b75763f2f 100644 --- a/dev/_sources/examples/plots/spc_convective_outlook.rst.txt +++ b/dev/_sources/examples/plots/spc_convective_outlook.rst.txt @@ -245,7 +245,7 @@ Add the geometry plot to a panel and container. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 7.844 seconds) + **Total running time of the script:** (0 minutes 7.500 seconds) .. _sphx_glr_download_examples_plots_spc_convective_outlook.py: diff --git a/dev/_sources/examples/plots/surface_declarative.rst.txt b/dev/_sources/examples/plots/surface_declarative.rst.txt index 031dd412f96..48b7d2a51cd 100644 --- a/dev/_sources/examples/plots/surface_declarative.rst.txt +++ b/dev/_sources/examples/plots/surface_declarative.rst.txt @@ -124,7 +124,7 @@ Georgia. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 1.117 seconds) + **Total running time of the script:** (0 minutes 1.097 seconds) .. _sphx_glr_download_examples_plots_surface_declarative.py: diff --git a/dev/_sources/examples/plots/upperair_declarative.rst.txt b/dev/_sources/examples/plots/upperair_declarative.rst.txt index 7f3f5b5b6b5..3906b11b24e 100644 --- a/dev/_sources/examples/plots/upperair_declarative.rst.txt +++ b/dev/_sources/examples/plots/upperair_declarative.rst.txt @@ -125,7 +125,7 @@ Use the declarative plotting interface to create a CONUS upper-air map for 500 h .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 0.719 seconds) + **Total running time of the script:** (0 minutes 0.710 seconds) .. _sphx_glr_download_examples_plots_upperair_declarative.py: diff --git a/dev/_sources/examples/sg_execution_times.rst.txt b/dev/_sources/examples/sg_execution_times.rst.txt index edc3463d440..28586425edf 100644 --- a/dev/_sources/examples/sg_execution_times.rst.txt +++ b/dev/_sources/examples/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**00:36.870** total execution time for 8 files **from examples**: +**00:35.878** total execution time for 8 files **from examples**: .. container:: @@ -33,26 +33,26 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_isentropic_example.py` (``isentropic_example.py``) - - 00:10.121 + - 00:09.675 - 0.0 * - :ref:`sphx_glr_examples_XArray_Projections.py` (``XArray_Projections.py``) - - 00:08.942 + - 00:08.768 - 0.0 * - :ref:`sphx_glr_examples_Four_Panel_Map.py` (``Four_Panel_Map.py``) - - 00:08.348 + - 00:08.162 - 0.0 * - :ref:`sphx_glr_examples_cross_section.py` (``cross_section.py``) - - 00:04.449 + - 00:04.413 - 0.0 * - :ref:`sphx_glr_examples_sigma_to_pressure_interpolation.py` (``sigma_to_pressure_interpolation.py``) - - 00:03.607 + - 00:03.524 - 0.0 * - :ref:`sphx_glr_examples_Advanced_Sounding_With_Complex_Layout.py` (``Advanced_Sounding_With_Complex_Layout.py``) - - 00:00.679 + - 00:00.639 - 0.0 * - :ref:`sphx_glr_examples_meteogram_metpy.py` (``meteogram_metpy.py``) - - 00:00.552 + - 00:00.531 - 0.0 * - :ref:`sphx_glr_examples_Advanced_Sounding.py` (``Advanced_Sounding.py``) - - 00:00.172 + - 00:00.165 - 0.0 diff --git a/dev/_sources/examples/sigma_to_pressure_interpolation.rst.txt b/dev/_sources/examples/sigma_to_pressure_interpolation.rst.txt index 4a444c9150a..03c00549bbd 100644 --- a/dev/_sources/examples/sigma_to_pressure_interpolation.rst.txt +++ b/dev/_sources/examples/sigma_to_pressure_interpolation.rst.txt @@ -188,7 +188,7 @@ variable for plotting. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 3.607 seconds) + **Total running time of the script:** (0 minutes 3.524 seconds) .. _sphx_glr_download_examples_sigma_to_pressure_interpolation.py: diff --git a/dev/_sources/index.rst.txt b/dev/_sources/index.rst.txt index a88fef48adb..f84aaf9012c 100644 --- a/dev/_sources/index.rst.txt +++ b/dev/_sources/index.rst.txt @@ -83,12 +83,8 @@ of MetPy GitHub Discussions. Our up-to-date references for grants and funding can be found `here `_. -.. image:: _static/NSF.jpg - :width: 100 px - :align: left - :alt: National Science Foundation logo - -.. image:: _static/unidata_150x150.png - :width: 100 px +.. image:: _static/NSF-Unidata_lockup_horizontal_2024.png + :class: no-scaled-link :align: center - :alt: Unidata logo + :height: 100px + :alt: NSF Unidata logo diff --git a/dev/_sources/sg_execution_times.rst.txt b/dev/_sources/sg_execution_times.rst.txt index 30c86cecbc1..7582ad914e0 100644 --- a/dev/_sources/sg_execution_times.rst.txt +++ b/dev/_sources/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**02:30.351** total execution time for 59 files **from all galleries**: +**02:26.567** total execution time for 59 files **from all galleries**: .. container:: @@ -33,151 +33,151 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_examples_plots_Mesonet_Stationplot.py` (``../examples/plots/Mesonet_Stationplot.py``) - - 00:13.848 + - 00:13.357 - 0.0 * - :ref:`sphx_glr_examples_plots_Station_Plot.py` (``../examples/plots/Station_Plot.py``) - - 00:13.231 + - 00:12.901 - 0.0 * - :ref:`sphx_glr_examples_gridding_Wind_SLP_Interpolation.py` (``../examples/gridding/Wind_SLP_Interpolation.py``) - - 00:11.862 + - 00:11.608 - 0.0 * - :ref:`sphx_glr_tutorials_declarative_tutorial.py` (``../tutorials/declarative_tutorial.py``) - - 00:10.847 + - 00:10.672 - 0.0 * - :ref:`sphx_glr_tutorials_area_tutorial.py` (``../tutorials/area_tutorial.py``) - - 00:10.603 + - 00:10.347 - 0.0 * - :ref:`sphx_glr_examples_isentropic_example.py` (``../examples/isentropic_example.py``) - - 00:10.121 + - 00:09.675 - 0.0 * - :ref:`sphx_glr_examples_XArray_Projections.py` (``../examples/XArray_Projections.py``) - - 00:08.942 + - 00:08.768 - 0.0 * - :ref:`sphx_glr_examples_Four_Panel_Map.py` (``../examples/Four_Panel_Map.py``) - - 00:08.348 + - 00:08.162 - 0.0 * - :ref:`sphx_glr_examples_plots_spc_convective_outlook.py` (``../examples/plots/spc_convective_outlook.py``) - - 00:07.844 + - 00:07.500 - 0.0 * - :ref:`sphx_glr_examples_plots_nhc_wind_probabilities.py` (``../examples/plots/nhc_wind_probabilities.py``) - - 00:06.592 + - 00:06.404 - 0.0 * - :ref:`sphx_glr_examples_plots_Plotting_Surface_Analysis.py` (``../examples/plots/Plotting_Surface_Analysis.py``) - - 00:06.245 + - 00:06.202 - 0.0 * - :ref:`sphx_glr_examples_plots_Combined_plotting.py` (``../examples/plots/Combined_plotting.py``) - - 00:06.094 + - 00:06.017 - 0.0 * - :ref:`sphx_glr_examples_formats_NEXRAD_Level_2_File.py` (``../examples/formats/NEXRAD_Level_2_File.py``) - - 00:05.089 + - 00:04.968 - 0.0 * - :ref:`sphx_glr_examples_cross_section.py` (``../examples/cross_section.py``) - - 00:04.449 + - 00:04.413 - 0.0 * - :ref:`sphx_glr_examples_gridding_Point_Interpolation.py` (``../examples/gridding/Point_Interpolation.py``) - - 00:03.864 + - 00:03.724 - 0.0 * - :ref:`sphx_glr_examples_sigma_to_pressure_interpolation.py` (``../examples/sigma_to_pressure_interpolation.py``) - - 00:03.607 + - 00:03.524 - 0.0 * - :ref:`sphx_glr_tutorials_xarray_tutorial.py` (``../tutorials/xarray_tutorial.py``) - - 00:02.777 + - 00:02.804 - 0.0 * - :ref:`sphx_glr_examples_plots_US_Counties.py` (``../examples/plots/US_Counties.py``) - - 00:02.258 + - 00:02.203 - 0.0 * - :ref:`sphx_glr_examples_formats_NEXRAD_Level_3_File.py` (``../examples/formats/NEXRAD_Level_3_File.py``) - - 00:01.537 + - 00:01.506 - 0.0 * - :ref:`sphx_glr_examples_plots_Station_Plot_with_Layout.py` (``../examples/plots/Station_Plot_with_Layout.py``) - - 00:01.502 + - 00:01.469 - 0.0 * - :ref:`sphx_glr_tutorials_upperair_soundings.py` (``../tutorials/upperair_soundings.py``) - - 00:01.134 + - 00:01.114 - 0.0 * - :ref:`sphx_glr_examples_plots_surface_declarative.py` (``../examples/plots/surface_declarative.py``) - - 00:01.117 + - 00:01.097 - 0.0 * - :ref:`sphx_glr_examples_formats_GINI_Water_Vapor.py` (``../examples/formats/GINI_Water_Vapor.py``) - - 00:00.892 + - 00:00.856 - 0.0 * - :ref:`sphx_glr_examples_plots_raster_declarative.py` (``../examples/plots/raster_declarative.py``) - - 00:00.784 + - 00:00.745 - 0.0 * - :ref:`sphx_glr_examples_plots_upperair_declarative.py` (``../examples/plots/upperair_declarative.py``) - - 00:00.719 + - 00:00.710 - 0.0 * - :ref:`sphx_glr_examples_Advanced_Sounding_With_Complex_Layout.py` (``../examples/Advanced_Sounding_With_Complex_Layout.py``) - - 00:00.679 + - 00:00.639 - 0.0 * - :ref:`sphx_glr_examples_meteogram_metpy.py` (``../examples/meteogram_metpy.py``) - - 00:00.552 + - 00:00.531 - 0.0 * - :ref:`sphx_glr_examples_calculations_Smoothing.py` (``../examples/calculations/Smoothing.py``) - - 00:00.521 + - 00:00.508 - 0.0 * - :ref:`sphx_glr_examples_plots_Simplified_Image_Plot.py` (``../examples/plots/Simplified_Image_Plot.py``) - - 00:00.517 + - 00:00.491 - 0.0 * - :ref:`sphx_glr_examples_gridding_Natural_Neighbor_Verification.py` (``../examples/gridding/Natural_Neighbor_Verification.py``) - - 00:00.413 + - 00:00.402 - 0.0 * - :ref:`sphx_glr_examples_gridding_Inverse_Distance_Verification.py` (``../examples/gridding/Inverse_Distance_Verification.py``) - - 00:00.344 + - 00:00.335 - 0.0 * - :ref:`sphx_glr_examples_plots_Simple_Sounding.py` (``../examples/plots/Simple_Sounding.py``) - - 00:00.300 + - 00:00.293 - 0.0 * - :ref:`sphx_glr_examples_gridding_Find_Natural_Neighbors_Verification.py` (``../examples/gridding/Find_Natural_Neighbors_Verification.py``) - - 00:00.292 + - 00:00.284 - 0.0 * - :ref:`sphx_glr_examples_calculations_Sounding_Calculations.py` (``../examples/calculations/Sounding_Calculations.py``) - - 00:00.247 + - 00:00.237 - 0.0 * - :ref:`sphx_glr_examples_plots_Hodograph_Inset.py` (``../examples/plots/Hodograph_Inset.py``) - - 00:00.206 + - 00:00.200 - 0.0 * - :ref:`sphx_glr_examples_plots_Skew-T_Layout.py` (``../examples/plots/Skew-T_Layout.py``) - - 00:00.198 + - 00:00.194 - 0.0 * - :ref:`sphx_glr_examples_plots_Sounding_LCL_Dataset.py` (``../examples/plots/Sounding_LCL_Dataset.py``) - - 00:00.180 + - 00:00.176 - 0.0 * - :ref:`sphx_glr_examples_Advanced_Sounding.py` (``../examples/Advanced_Sounding.py``) - - 00:00.172 + - 00:00.165 - 0.0 * - :ref:`sphx_glr_examples_calculations_QVector.py` (``../examples/calculations/QVector.py``) - - 00:00.141 - - 0.0 - * - :ref:`sphx_glr_examples_calculations_Total_Deformation.py` (``../examples/calculations/Total_Deformation.py``) - - 00:00.139 + - 00:00.136 - 0.0 * - :ref:`sphx_glr_examples_calculations_Absolute_Vorticity.py` (``../examples/calculations/Absolute_Vorticity.py``) - - 00:00.138 + - 00:00.133 + - 0.0 + * - :ref:`sphx_glr_examples_calculations_Total_Deformation.py` (``../examples/calculations/Total_Deformation.py``) + - 00:00.132 - 0.0 * - :ref:`sphx_glr_examples_calculations_Vorticity.py` (``../examples/calculations/Vorticity.py``) - - 00:00.137 + - 00:00.132 - 0.0 * - :ref:`sphx_glr_examples_calculations_Shearing_Deformation.py` (``../examples/calculations/Shearing_Deformation.py``) - - 00:00.136 + - 00:00.131 - 0.0 * - :ref:`sphx_glr_examples_calculations_Stretching_Deformation.py` (``../examples/calculations/Stretching_Deformation.py``) - - 00:00.134 + - 00:00.131 - 0.0 * - :ref:`sphx_glr_examples_calculations_Divergence.py` (``../examples/calculations/Divergence.py``) - - 00:00.122 + - 00:00.116 - 0.0 * - :ref:`sphx_glr_examples_calculations_Advection.py` (``../examples/calculations/Advection.py``) - - 00:00.114 + - 00:00.110 - 0.0 * - :ref:`sphx_glr_examples_calculations_Wind_Speed.py` (``../examples/calculations/Wind_Speed.py``) - - 00:00.113 + - 00:00.106 - 0.0 * - :ref:`sphx_glr_examples_plots_Simple_Fronts_Plot.py` (``../examples/plots/Simple_Fronts_Plot.py``) - - 00:00.098 + - 00:00.097 - 0.0 * - :ref:`sphx_glr_examples_calculations_Equivalent_Potential_Temperature.py` (``../examples/calculations/Equivalent_Potential_Temperature.py``) - - 00:00.073 + - 00:00.070 - 0.0 * - :ref:`sphx_glr_examples_calculations_Gradient.py` (``../examples/calculations/Gradient.py``) - 00:00.013 @@ -185,14 +185,14 @@ Computation times * - :ref:`sphx_glr_tutorials_unit_tutorial.py` (``../tutorials/unit_tutorial.py``) - 00:00.012 - 0.0 - * - :ref:`sphx_glr_examples_calculations_Thickness_Hydrostatic.py` (``../examples/calculations/Thickness_Hydrostatic.py``) + * - :ref:`sphx_glr_examples_calculations_Bulk_Shear.py` (``../examples/calculations/Bulk_Shear.py``) - 00:00.010 - 0.0 - * - :ref:`sphx_glr_examples_calculations_Bulk_Shear.py` (``../examples/calculations/Bulk_Shear.py``) + * - :ref:`sphx_glr_examples_calculations_Thickness_Hydrostatic.py` (``../examples/calculations/Thickness_Hydrostatic.py``) - 00:00.010 - 0.0 * - :ref:`sphx_glr_examples_calculations_Mean_Pressure_Weighted.py` (``../examples/calculations/Mean_Pressure_Weighted.py``) - - 00:00.010 + - 00:00.009 - 0.0 * - :ref:`sphx_glr_examples_calculations_Static_Stability.py` (``../examples/calculations/Static_Stability.py``) - 00:00.008 diff --git a/dev/_sources/tutorials/area_tutorial.rst.txt b/dev/_sources/tutorials/area_tutorial.rst.txt index 105f3fa8c95..308c4378299 100644 --- a/dev/_sources/tutorials/area_tutorial.rst.txt +++ b/dev/_sources/tutorials/area_tutorial.rst.txt @@ -522,7 +522,7 @@ some surface observations. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 10.603 seconds) + **Total running time of the script:** (0 minutes 10.347 seconds) .. _sphx_glr_download_tutorials_area_tutorial.py: diff --git a/dev/_sources/tutorials/declarative_tutorial.rst.txt b/dev/_sources/tutorials/declarative_tutorial.rst.txt index cf0e00806a6..c9d522acfe2 100644 --- a/dev/_sources/tutorials/declarative_tutorial.rst.txt +++ b/dev/_sources/tutorials/declarative_tutorial.rst.txt @@ -897,7 +897,7 @@ Default value is zero (e.g., no points are removed from the plot). .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 10.847 seconds) + **Total running time of the script:** (0 minutes 10.672 seconds) .. _sphx_glr_download_tutorials_declarative_tutorial.py: diff --git a/dev/_sources/tutorials/sg_execution_times.rst.txt b/dev/_sources/tutorials/sg_execution_times.rst.txt index 6cf22382204..39e220b5329 100644 --- a/dev/_sources/tutorials/sg_execution_times.rst.txt +++ b/dev/_sources/tutorials/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**00:25.372** total execution time for 5 files **from tutorials**: +**00:24.948** total execution time for 5 files **from tutorials**: .. container:: @@ -33,16 +33,16 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_tutorials_declarative_tutorial.py` (``declarative_tutorial.py``) - - 00:10.847 + - 00:10.672 - 0.0 * - :ref:`sphx_glr_tutorials_area_tutorial.py` (``area_tutorial.py``) - - 00:10.603 + - 00:10.347 - 0.0 * - :ref:`sphx_glr_tutorials_xarray_tutorial.py` (``xarray_tutorial.py``) - - 00:02.777 + - 00:02.804 - 0.0 * - :ref:`sphx_glr_tutorials_upperair_soundings.py` (``upperair_soundings.py``) - - 00:01.134 + - 00:01.114 - 0.0 * - :ref:`sphx_glr_tutorials_unit_tutorial.py` (``unit_tutorial.py``) - 00:00.012 diff --git a/dev/_sources/tutorials/upperair_soundings.rst.txt b/dev/_sources/tutorials/upperair_soundings.rst.txt index 3f79e962383..595fd755816 100644 --- a/dev/_sources/tutorials/upperair_soundings.rst.txt +++ b/dev/_sources/tutorials/upperair_soundings.rst.txt @@ -329,7 +329,7 @@ which are not drawn. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 1.134 seconds) + **Total running time of the script:** (0 minutes 1.114 seconds) .. _sphx_glr_download_tutorials_upperair_soundings.py: diff --git a/dev/_sources/tutorials/xarray_tutorial.rst.txt b/dev/_sources/tutorials/xarray_tutorial.rst.txt index b6590056dfd..35752e202c5 100644 --- a/dev/_sources/tutorials/xarray_tutorial.rst.txt +++ b/dev/_sources/tutorials/xarray_tutorial.rst.txt @@ -481,22 +481,22 @@ First, some general imports... geospatial_lat_min: ... geospatial_lat_max: ... geospatial_lon_min: ... - geospatial_lon_max: ...
    @@ -957,20 +957,20 @@ if we look at just a single data variable? Grib2_Level_Type: 100 Grib2_Level_Desc: Isobaric surface Grib2_Generating_Process_Type: Forecast - grid_mapping: LatLon_361X720-0p25S-180p00E
  • long_name :
    Temperature @ Isobaric surface
    units :
    K
    Grib_Variable_Id :
    VAR_0-0-0_L100
    Grib2_Parameter :
    [0 0 0]
    Grib2_Parameter_Discipline :
    Meteorological products
    Grib2_Parameter_Category :
    Temperature
    Grib2_Parameter_Name :
    Temperature
    Grib2_Level_Type :
    100
    Grib2_Level_Desc :
    Isobaric surface
    Grib2_Generating_Process_Type :
    Forecast
    grid_mapping :
    LatLon_361X720-0p25S-180p00E


    • @@ -1434,20 +1434,20 @@ with that type standard_name: time long_name: time udunits: Hour since 2017-09-05T12:00:00Z - _metpy_axis: time
  • standard_name :
    time
    long_name :
    time
    udunits :
    Hour since 2017-09-05T12:00:00Z
    _metpy_axis :
    time


    • @@ -1958,20 +1958,20 @@ the CRS using the ``.assign_crs()`` method: Grib2_Level_Type: 100 Grib2_Level_Desc: Isobaric surface Grib2_Generating_Process_Type: Forecast - grid_mapping: LatLon_361X720-0p25S-180p00E
  • long_name :
    Temperature @ Isobaric surface
    units :
    K
    Grib_Variable_Id :
    VAR_0-0-0_L100
    Grib2_Parameter :
    [0 0 0]
    Grib2_Parameter_Discipline :
    Meteorological products
    Grib2_Parameter_Category :
    Temperature
    Grib2_Parameter_Name :
    Temperature
    Grib2_Level_Type :
    100
    Grib2_Level_Desc :
    Isobaric surface
    Grib2_Generating_Process_Type :
    Forecast
    grid_mapping :
    LatLon_361X720-0p25S-180p00E


    • @@ -2040,7 +2040,7 @@ corresponding to this CRS: - 2024-10-02T21:27:40.902189 + 2024-10-16T18:28:41.065588 image/svg+xml @@ -2065,10 +2065,12 @@ corresponding to this CRS: @@ -2083,7 +2085,7 @@ corresponding to this CRS: L 20.353759 138.1198 L 20.323382 138.074224 L 19.822506 137.861642 - " clip-path="url(#pd6214d6d17)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #000000"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + " clip-path="url(#p2eb7356331)" style="fill: none; stroke: #b0b0b0; stroke-width: 0.8"/> + - 
    <cartopy.crs.PlateCarree object at 0x7f966a085210>
    + 
    <cartopy.crs.PlateCarree object at 0x7f4cfc79cb50>


    @@ -8443,13 +8449,13 @@ inside the xarray object into a Pint ``Quantity`` object) Grib2_Level_Type: 100 Grib2_Level_Desc: Isobaric surface Grib2_Generating_Process_Type: Forecast - grid_mapping: LatLon_361X720-0p25S-180p00E
  • long_name :
    Geopotential height @ Isobaric surface
    Grib_Variable_Id :
    VAR_0-3-5_L100
    Grib2_Parameter :
    [0 3 5]
    Grib2_Parameter_Discipline :
    Meteorological products
    Grib2_Parameter_Category :
    Mass
    Grib2_Parameter_Name :
    Geopotential height
    Grib2_Level_Type :
    100
    Grib2_Level_Desc :
    Isobaric surface
    Grib2_Generating_Process_Type :
    Forecast
    grid_mapping :
    LatLon_361X720-0p25S-180p00E


    • @@ -8885,20 +8891,20 @@ mean), the units are preserved time1 datetime64[ns] 8B 2017-09-05T18:00:00 reftime datetime64[ns] 8B ... * latitude (latitude) float32 324B 50.0 49.5 49.0 48.5 ... 11.0 10.5 10.0 - isobaric3 float64 8B 5e+04


    • @@ -9322,7 +9328,7 @@ unit-naive array with the unit as a text attribute * latitude (latitude) float32 324B 50.0 49.5 49.0 48.5 ... 11.0 10.5 10.0 isobaric3 float64 8B 5e+04 Attributes: - units: meter
  • units :
    meter


    • @@ -9766,11 +9772,11 @@ Unit-based selection/indexing: Grib2_Level_Type: 100 Grib2_Level_Desc: Isobaric surface Grib2_Generating_Process_Type: Forecast - grid_mapping: LatLon_361X720-0p25S-180p00E
  • long_name :
    Geopotential height @ Isobaric surface
    units :
    gpm
    Grib_Variable_Id :
    VAR_0-3-5_L100
    Grib2_Parameter :
    [0 3 5]
    Grib2_Parameter_Discipline :
    Meteorological products
    Grib2_Parameter_Category :
    Mass
    Grib2_Parameter_Name :
    Geopotential height
    Grib2_Level_Type :
    100
    Grib2_Level_Desc :
    Isobaric surface
    Grib2_Generating_Process_Type :
    Forecast
    grid_mapping :
    LatLon_361X720-0p25S-180p00E


    • @@ -10245,16 +10251,16 @@ Unit conversion: Grib2_Level_Type: 100 Grib2_Level_Desc: Isobaric surface Grib2_Generating_Process_Type: Forecast - grid_mapping: LatLon_361X720-0p25S-180p00E
  • long_name :
    Temperature @ Isobaric surface
    Grib_Variable_Id :
    VAR_0-0-0_L100
    Grib2_Parameter :
    [0 0 0]
    Grib2_Parameter_Discipline :
    Meteorological products
    Grib2_Parameter_Category :
    Temperature
    Grib2_Parameter_Name :
    Temperature
    Grib2_Level_Type :
    100
    Grib2_Level_Desc :
    Isobaric surface
    Grib2_Generating_Process_Type :
    Forecast
    grid_mapping :
    LatLon_361X720-0p25S-180p00E


    • @@ -10737,16 +10743,16 @@ To base unit conversion: Grib2_Level_Type: 100 Grib2_Level_Desc: Isobaric surface Grib2_Generating_Process_Type: Forecast - grid_mapping: LatLon_361X720-0p25S-180p00E
  • long_name :
    Temperature @ Isobaric surface
    Grib_Variable_Id :
    VAR_0-0-0_L100
    Grib2_Parameter :
    [0 0 0]
    Grib2_Parameter_Discipline :
    Meteorological products
    Grib2_Parameter_Category :
    Temperature
    Grib2_Parameter_Name :
    Temperature
    Grib2_Level_Type :
    100
    Grib2_Level_Desc :
    Isobaric surface
    Grib2_Generating_Process_Type :
    Forecast
    grid_mapping :
    LatLon_361X720-0p25S-180p00E


    • @@ -11177,7 +11183,7 @@ Unit conversion for coordinates: Attributes: units: hPa positive: down - _metpy_axis: vertical + _metpy_axis: vertical

    @@ -11649,13 +11655,13 @@ using the attached coordinate data/metadata to determine grid arguments * latitude (latitude) float32 324B 50.0 49.5 49.0 48.5 ... 11.0 10.5 10.0 * longitude (longitude) float32 524B 250.0 250.5 251.0 ... 314.0 314.5 315.0 metpy_crs object 8B Projection: latitude_longitude - isobaric3 float64 8B 5e+04


    • @@ -11779,7 +11785,7 @@ following .. code-block:: none - + @@ -12215,12 +12221,12 @@ work is required to manually supply the required information, for example, latitude (y, x) float64 72B 38.5 38.49 38.48 39.4 ... 40.3 40.29 40.28 longitude (y, x) float64 72B -97.5 -96.35 -95.2 ... -97.5 -96.32 -95.14 Data variables: - temperature (y, x) int64 72B <Quantity([[0 1 2] [3 4 5] [6 7 8]], 'deg...
    • temperature
      (y, x)
      int64
      <Quantity([[0 1 2] [3 4 5] [6 ...
      Magnitude
      [[0 1 2] [3 4 5] [6 7 8]]
      Unitsdegree_Celsius
    • y
      PandasIndex
      PandasIndex(Index([0.0, 100000.0, 200000.0], dtype='float64', name='y'))
    • x
      PandasIndex
      PandasIndex(Index([0.0, 100000.0, 200000.0], dtype='float64', name='x'))


    • @@ -12329,7 +12335,7 @@ in handy. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 2.777 seconds) + **Total running time of the script:** (0 minutes 2.804 seconds) .. _sphx_glr_download_tutorials_xarray_tutorial.py: diff --git a/dev/_static/NSF-Unidata_lockup_horizontal_2024.png b/dev/_static/NSF-Unidata_lockup_horizontal_2024.png new file mode 100644 index 00000000000..37e1a452ed9 Binary files /dev/null and b/dev/_static/NSF-Unidata_lockup_horizontal_2024.png differ diff --git a/dev/_static/NSF.jpg b/dev/_static/NSF.jpg deleted file mode 100644 index 4153620c45b..00000000000 Binary files a/dev/_static/NSF.jpg and /dev/null differ diff --git a/dev/_static/basic.css b/dev/_static/basic.css index 2af6139e6b9..2a9e4114ac6 100644 --- a/dev/_static/basic.css +++ b/dev/_static/basic.css @@ -1,12 +1,5 @@ /* - * basic.css - * ~~~~~~~~~ - * * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ /* -- main layout ----------------------------------------------------------- */ @@ -115,15 +108,11 @@ img { /* -- search page ----------------------------------------------------------- */ ul.search { - margin: 10px 0 0 20px; - padding: 0; + margin-top: 10px; } ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; + padding: 5px 0; } ul.search li a { diff --git a/dev/_static/doctools.js b/dev/_static/doctools.js index 4d67807d17d..0398ebb9f03 100644 --- a/dev/_static/doctools.js +++ b/dev/_static/doctools.js @@ -1,12 +1,5 @@ /* - * doctools.js - * ~~~~~~~~~~~ - * * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; diff --git a/dev/_static/language_data.js b/dev/_static/language_data.js index 367b8ed81b4..c7fe6c6fafa 100644 --- a/dev/_static/language_data.js +++ b/dev/_static/language_data.js @@ -1,13 +1,6 @@ /* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; diff --git a/dev/_static/searchtools.js b/dev/_static/searchtools.js index b08d58c9b9b..2c774d17aff 100644 --- a/dev/_static/searchtools.js +++ b/dev/_static/searchtools.js @@ -1,12 +1,5 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; @@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") { // and returns the new score. /* score: result => { - const [docname, title, anchor, descr, score, filename] = result + const [docname, title, anchor, descr, score, filename, kind] = result return score }, */ @@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") { }; } +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + const _removeChildren = (element) => { while (element && element.lastChild) element.removeChild(element.lastChild); }; @@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => { const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; const contentRoot = document.documentElement.dataset.content_root; - const [docName, title, anchor, descr, score, _filename] = item; + const [docName, title, anchor, descr, score, _filename, kind] = item; let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); let requestUrl; let linkUrl; if (docBuilder === "dirhtml") { @@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => { "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." ); else - Search.status.innerText = _( - "Search finished, found ${resultCount} page(s) matching the search query." + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( @@ -138,7 +145,7 @@ const _displayNextItem = ( else _finishSearch(resultCount); }; // Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. // Order the results by score (in opposite order of appearance, since the // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. const _orderResultsByScoreThenName = (a, b) => { @@ -248,6 +255,7 @@ const Search = { searchSummary.classList.add("search-summary"); searchSummary.innerText = ""; const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); searchList.classList.add("search"); const out = document.getElementById("search-results"); @@ -318,7 +326,7 @@ const Search = { const indexEntries = Search._index.indexentries; // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename]. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. const normalResults = []; const nonMainIndexResults = []; @@ -337,6 +345,7 @@ const Search = { null, score + boost, filenames[file], + SearchResultKind.title, ]); } } @@ -354,6 +363,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.index, ]; if (isMain) { normalResults.push(result); @@ -475,6 +485,7 @@ const Search = { descr, score, filenames[match[0]], + SearchResultKind.object, ]); }; Object.keys(objects).forEach((prefix) => @@ -585,6 +596,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.text, ]); } return results; diff --git a/dev/_static/unidata_150x150.png b/dev/_static/unidata_150x150.png deleted file mode 100644 index 9ddd2bea04e..00000000000 Binary files a/dev/_static/unidata_150x150.png and /dev/null differ diff --git a/dev/api/areas.html b/dev/api/areas.html index fd4d59916d2..f8897d4f8b3 100644 --- a/dev/api/areas.html +++ b/dev/api/areas.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -3175,7 +3175,7 @@

    zw - ZIMBABWE

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.absolute_momentum.html b/dev/api/generated/metpy.calc.absolute_momentum.html index 88db1daf72e..d0e8c206578 100644 --- a/dev/api/generated/metpy.calc.absolute_momentum.html +++ b/dev/api/generated/metpy.calc.absolute_momentum.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -788,7 +788,7 @@

    absolute_momentum

    • u (xarray.DataArray) – The input DataArray of the x-component (in terms of data projection) of the wind.

    • v (xarray.DataArray) – The input DataArray of the y-component (in terms of data projection) of the wind.

      • -

    • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as +

    • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as set by metpy.interpolate.cross_section

    @@ -902,7 +902,7 @@

    absolute_momentum

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.absolute_vorticity.html b/dev/api/generated/metpy.calc.absolute_vorticity.html index 951cceae603..20e4b4703fc 100644 --- a/dev/api/generated/metpy.calc.absolute_vorticity.html +++ b/dev/api/generated/metpy.calc.absolute_vorticity.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,9 +794,9 @@

    absolute_vorticitypint.Quantity, optional) – Latitude of the wind data. Optional if xarray.DataArray with latitude/longitude coordinates used as input. Note that an argument without units is treated as dimensionless, which translates to radians.

    -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -922,7 +922,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.add_height_to_pressure.html b/dev/api/generated/metpy.calc.add_height_to_pressure.html index ad05aef1068..0f81f8f64ed 100644 --- a/dev/api/generated/metpy.calc.add_height_to_pressure.html +++ b/dev/api/generated/metpy.calc.add_height_to_pressure.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -893,7 +893,7 @@

    add_height_to_pressure

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.add_pressure_to_height.html b/dev/api/generated/metpy.calc.add_pressure_to_height.html index a5a6b86efaf..ba1aca4b149 100644 --- a/dev/api/generated/metpy.calc.add_pressure_to_height.html +++ b/dev/api/generated/metpy.calc.add_pressure_to_height.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -891,7 +891,7 @@

    add_pressure_to_height

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.advection.html b/dev/api/generated/metpy.calc.advection.html index 4b3c6d9cdf2..d87aeb6d544 100644 --- a/dev/api/generated/metpy.calc.advection.html +++ b/dev/api/generated/metpy.calc.advection.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -806,9 +806,9 @@

    advectionpint.Quantity or None, optional) – Grid spacing in the x dimension.

  • dy (pint.Quantity or None, optional) – Grid spacing in the y dimension.

  • dz (pint.Quantity or None, optional) – Grid spacing in the z dimension.

    • -

  • x_dim (int or None, optional) – Axis number in the x dimension. Defaults to -1 for (…, Z, Y, X) dimension ordering.

    • -

  • y_dim (int or None, optional) – Axis number in the y dimension. Defaults to -2 for (…, Z, Y, X) dimension ordering.

    • -

  • vertical_dim (int or None, optional) – Axis number in the z dimension. Defaults to -3 for (…, Z, Y, X) dimension ordering.

    • +

  • x_dim (int or None, optional) – Axis number in the x dimension. Defaults to -1 for (…, Z, Y, X) dimension ordering.

    • +

  • y_dim (int or None, optional) – Axis number in the y dimension. Defaults to -2 for (…, Z, Y, X) dimension ordering.

    • +

  • vertical_dim (int or None, optional) – Axis number in the z dimension. Defaults to -3 for (…, Z, Y, X) dimension ordering.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate.

  • meridional_scale (pint.Quantity, optional) – Meridional scale of map projection at data coordinate.

  • latitude (pint.Quantity, optional) – Latitude of data. Optional if xarray.DataArray with latitude/longitude coordinates @@ -935,7 +935,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.ageostrophic_wind.html b/dev/api/generated/metpy.calc.ageostrophic_wind.html index a4328a6d8ce..58e60b94441 100644 --- a/dev/api/generated/metpy.calc.ageostrophic_wind.html +++ b/dev/api/generated/metpy.calc.ageostrophic_wind.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -796,9 +796,9 @@

    ageostrophic_windxarray.DataArray with latitude coordinate used as input. Note that an argument without units is treated as dimensionless, which is equivalent to radians.

    • -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -913,7 +913,7 @@

    ageostrophic_wind

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.altimeter_to_sea_level_pressure.html b/dev/api/generated/metpy.calc.altimeter_to_sea_level_pressure.html index de67c0f4ad5..4f24afdc8a9 100644 --- a/dev/api/generated/metpy.calc.altimeter_to_sea_level_pressure.html +++ b/dev/api/generated/metpy.calc.altimeter_to_sea_level_pressure.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -918,7 +918,7 @@

    altimeter_to_sea_level_pressure

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.altimeter_to_station_pressure.html b/dev/api/generated/metpy.calc.altimeter_to_station_pressure.html index 964aff94fff..f0f14860c4e 100644 --- a/dev/api/generated/metpy.calc.altimeter_to_station_pressure.html +++ b/dev/api/generated/metpy.calc.altimeter_to_station_pressure.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -922,7 +922,7 @@

    altimeter_to_station_pressure

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.angle_to_direction.html b/dev/api/generated/metpy.calc.angle_to_direction.html index 19510de5271..c93430c3943 100644 --- a/dev/api/generated/metpy.calc.angle_to_direction.html +++ b/dev/api/generated/metpy.calc.angle_to_direction.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,9 +785,9 @@

    angle_to_direction
    Parameters:
      -

    • input_angle (float or array-like) – Angles such as 0, 25, 45, 360, 410, etc.

      • -

    • full (bool) – True returns full text (South), False returns abbreviated text (S)

      • -

    • level (int) – Level of detail (3 = N/NNE/NE/ENE/E… 2 = N/NE/E/SE… 1 = N/E/S/W)

      • +

    • input_angle (float or array-like) – Angles such as 0, 25, 45, 360, 410, etc.

      • +

    • full (bool) – True returns full text (South), False returns abbreviated text (S)

      • +

    • level (int) – Level of detail (3 = N/NNE/NE/ENE/E… 2 = N/NE/E/SE… 1 = N/E/S/W)

    Returns:
    @@ -896,7 +896,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.apparent_temperature.html b/dev/api/generated/metpy.calc.apparent_temperature.html index 329c607a6e8..6cfe4a157aa 100644 --- a/dev/api/generated/metpy.calc.apparent_temperature.html +++ b/dev/api/generated/metpy.calc.apparent_temperature.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,10 +791,10 @@

    apparent_temperature

    speed (pint.Quantity) – Wind speed at 10m. If instead the winds are at face level, face_level_winds should be set to True and the 1.5 multiplicative correction will be applied automatically.

    • -

  • face_level_winds (bool, optional) – A flag indicating whether the wind speeds were measured at facial +

  • face_level_winds (bool, optional) – A flag indicating whether the wind speeds were measured at facial level instead of 10m, thus requiring a correction. Defaults to False.

    • -

  • mask_undefined (bool, optional) – A flag indicating whether a masked array should be returned with +

  • mask_undefined (bool, optional) – A flag indicating whether a masked array should be returned with values where wind chill or heat_index is undefined masked. For wind chill, these are values where the temperature > 50F or wind speed <= 3 miles per hour. For heat index, these are values @@ -901,7 +901,7 @@

    apparent_temperature

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.azimuth_range_to_lat_lon.html b/dev/api/generated/metpy.calc.azimuth_range_to_lat_lon.html index 2b219431fee..e75f8820686 100644 --- a/dev/api/generated/metpy.calc.azimuth_range_to_lat_lon.html +++ b/dev/api/generated/metpy.calc.azimuth_range_to_lat_lon.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,8 +787,8 @@

    azimuth_range_to_lat_lonpint.Quantity, assumed to be in degrees.

  • ranges (array-like) – array of range distances from the pole. Typically in meters.

    • -

  • center_lat (float) – The latitude of the pole in decimal degrees

    • -

  • center_lon (float) – The longitude of the pole in decimal degrees

    • +

  • center_lat (float) – The latitude of the pole in decimal degrees

    • +

  • center_lon (float) – The longitude of the pole in decimal degrees

  • geod (pyproj.Geod or None) – PyProj Geod to use for forward azimuth and distance calculations. If None, use a default spherical ellipsoid.

    • @@ -897,7 +897,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.brunt_vaisala_frequency.html b/dev/api/generated/metpy.calc.brunt_vaisala_frequency.html index ca1cfdc13dc..e0582bf050f 100644 --- a/dev/api/generated/metpy.calc.brunt_vaisala_frequency.html +++ b/dev/api/generated/metpy.calc.brunt_vaisala_frequency.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -792,7 +792,7 @@

    brunt_vaisala_frequency

    • height (xarray.DataArray or pint.Quantity) – Atmospheric (geopotential) height

    • potential_temperature (xarray.DataArray or pint.Quantity) – Atmospheric potential temperature

      • -

    • vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0, +

    • vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0, unless height and potential_temperature given as xarray.DataArray, in which case it is automatically determined from the coordinate metadata.

    @@ -898,7 +898,7 @@

    brunt_vaisala_frequency

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.brunt_vaisala_frequency_squared.html b/dev/api/generated/metpy.calc.brunt_vaisala_frequency_squared.html index 25bc4aa7f79..b344c4e3864 100644 --- a/dev/api/generated/metpy.calc.brunt_vaisala_frequency_squared.html +++ b/dev/api/generated/metpy.calc.brunt_vaisala_frequency_squared.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -791,7 +791,7 @@

    brunt_vaisala_frequency_squared

    • height (xarray.DataArray or pint.Quantity) – Atmospheric (geopotential) height

    • potential_temperature (xarray.DataArray or pint.Quantity) – Atmospheric potential temperature

      • -

    • vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0, +

    • vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0, unless height and potential_temperature given as xarray.DataArray, in which case it is automatically determined from the coordinate metadata.

    @@ -897,7 +897,7 @@

    brunt_vaisala_frequency_squared

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.brunt_vaisala_period.html b/dev/api/generated/metpy.calc.brunt_vaisala_period.html index 844391f8f25..a561715442d 100644 --- a/dev/api/generated/metpy.calc.brunt_vaisala_period.html +++ b/dev/api/generated/metpy.calc.brunt_vaisala_period.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -791,7 +791,7 @@

    brunt_vaisala_period

    • height (xarray.DataArray or pint.Quantity) – Atmospheric (geopotential) height

    • potential_temperature (xarray.DataArray or pint.Quantity) – Atmospheric potential temperature

      • -

    • vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0, +

    • vertical_dim (int, optional) – The axis corresponding to vertical in the potential temperature array, defaults to 0, unless height and potential_temperature given as xarray.DataArray, in which case it is automatically determined from the coordinate metadata.

    @@ -897,7 +897,7 @@

    brunt_vaisala_period

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.bulk_shear.html b/dev/api/generated/metpy.calc.bulk_shear.html index 422cd7c62f0..e4b0bc25261 100644 --- a/dev/api/generated/metpy.calc.bulk_shear.html +++ b/dev/api/generated/metpy.calc.bulk_shear.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -922,7 +922,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.bunkers_storm_motion.html b/dev/api/generated/metpy.calc.bunkers_storm_motion.html index 0f3bbb63855..33ce3bc8ac6 100644 --- a/dev/api/generated/metpy.calc.bunkers_storm_motion.html +++ b/dev/api/generated/metpy.calc.bunkers_storm_motion.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -928,7 +928,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.cape_cin.html b/dev/api/generated/metpy.calc.cape_cin.html index 72a45b84458..0c61e87fde2 100644 --- a/dev/api/generated/metpy.calc.cape_cin.html +++ b/dev/api/generated/metpy.calc.cape_cin.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -793,9 +793,9 @@

    cape_cin

  • temperature (pint.Quantity) – Atmospheric temperature corresponding to pressure

  • dewpoint (pint.Quantity) – Atmospheric dewpoint corresponding to pressure

  • parcel_profile (pint.Quantity) – Temperature profile of the parcel

    • -

  • which_lfc (str) – Choose which LFC to integrate from. Valid options are ‘top’, ‘bottom’, ‘wide’, +

  • which_lfc (str) – Choose which LFC to integrate from. Valid options are ‘top’, ‘bottom’, ‘wide’, and ‘most_cape’. Default is ‘bottom’.

    • -

  • which_el (str) – Choose which EL to integrate to. Valid options are ‘top’, ‘bottom’, ‘wide’, +

  • which_el (str) – Choose which EL to integrate to. Valid options are ‘top’, ‘bottom’, ‘wide’, and ‘most_cape’. Default is ‘top’.

    • @@ -958,7 +958,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.ccl.html b/dev/api/generated/metpy.calc.ccl.html index 955214f86d4..e51135ec51d 100644 --- a/dev/api/generated/metpy.calc.ccl.html +++ b/dev/api/generated/metpy.calc.ccl.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,7 +794,7 @@

    ccl#

    Only needed when specifying a mixed layer depth as a height.

  • mixed_layer_depth (pint.Quantity, optional) – The thickness of the mixed layer as a pressure or height above the bottom of the layer (default None).

    • -

  • which (str, optional) – Pick which CCL value to return; must be one of ‘top’, ‘bottom’, or ‘all’. +

  • which (str, optional) – Pick which CCL value to return; must be one of ‘top’, ‘bottom’, or ‘all’. ‘top’ returns the lowest-pressure CCL (default), ‘bottom’ returns the highest-pressure CCL, ‘all’ returns every CCL in a Pint.Quantity array.

    • @@ -916,7 +916,7 @@

    ccl#

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.corfidi_storm_motion.html b/dev/api/generated/metpy.calc.corfidi_storm_motion.html index c73ad83c470..6b0d8cc80f8 100644 --- a/dev/api/generated/metpy.calc.corfidi_storm_motion.html +++ b/dev/api/generated/metpy.calc.corfidi_storm_motion.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -927,7 +927,7 @@

    corfidi_storm_motion

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.coriolis_parameter.html b/dev/api/generated/metpy.calc.coriolis_parameter.html index 147328011a9..4363378eaf1 100644 --- a/dev/api/generated/metpy.calc.coriolis_parameter.html +++ b/dev/api/generated/metpy.calc.coriolis_parameter.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -877,7 +877,7 @@

    coriolis_parameter

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.critical_angle.html b/dev/api/generated/metpy.calc.critical_angle.html index 07a3f32e84a..1db012e9da8 100644 --- a/dev/api/generated/metpy.calc.critical_angle.html +++ b/dev/api/generated/metpy.calc.critical_angle.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -915,7 +915,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.cross_section_components.html b/dev/api/generated/metpy.calc.cross_section_components.html index dd9f2a05fe2..2f22e115066 100644 --- a/dev/api/generated/metpy.calc.cross_section_components.html +++ b/dev/api/generated/metpy.calc.cross_section_components.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,7 +787,7 @@

    cross_section_componentsxarray.DataArray) – The input DataArray of the y-component (in terms of data projection) of the vector field.

    -

  • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as +

  • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as set by metpy.interpolate.cross_section

    • @@ -896,7 +896,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.cross_totals.html b/dev/api/generated/metpy.calc.cross_totals.html index cb3504fa0d3..ff392249db3 100644 --- a/dev/api/generated/metpy.calc.cross_totals.html +++ b/dev/api/generated/metpy.calc.cross_totals.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -797,7 +797,7 @@

    cross_totalspint.Quantity) – Pressure level(s), in order from highest to lowest pressure

  • temperature (pint.Quantity) – Temperature corresponding to pressure

  • dewpoint (pint.Quantity) – Dewpoint temperature corresponding to pressure

    • -

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    • @@ -924,7 +924,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.density.html b/dev/api/generated/metpy.calc.density.html index 28e6ea9c48e..8285214e0eb 100644 --- a/dev/api/generated/metpy.calc.density.html +++ b/dev/api/generated/metpy.calc.density.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -899,7 +899,7 @@

    density#<

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.dewpoint.html b/dev/api/generated/metpy.calc.dewpoint.html index e3d6df86256..8420a4fe232 100644 --- a/dev/api/generated/metpy.calc.dewpoint.html +++ b/dev/api/generated/metpy.calc.dewpoint.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -904,7 +904,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.dewpoint_from_relative_humidity.html b/dev/api/generated/metpy.calc.dewpoint_from_relative_humidity.html index b0d5a7f580c..cff3997968f 100644 --- a/dev/api/generated/metpy.calc.dewpoint_from_relative_humidity.html +++ b/dev/api/generated/metpy.calc.dewpoint_from_relative_humidity.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -906,7 +906,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.dewpoint_from_specific_humidity.html b/dev/api/generated/metpy.calc.dewpoint_from_specific_humidity.html index 336ef4c73bb..4f0a9c97c24 100644 --- a/dev/api/generated/metpy.calc.dewpoint_from_specific_humidity.html +++ b/dev/api/generated/metpy.calc.dewpoint_from_specific_humidity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -912,7 +912,7 @@

    dewpoint_from_specific_humidity

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.divergence.html b/dev/api/generated/metpy.calc.divergence.html index 7b643616864..af576431a82 100644 --- a/dev/api/generated/metpy.calc.divergence.html +++ b/dev/api/generated/metpy.calc.divergence.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -792,9 +792,9 @@

    divergencepint.Quantity, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional if xarray.DataArray with latitude/longitude coordinates used as input. Keyword-only argument.

    -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -930,7 +930,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.downdraft_cape.html b/dev/api/generated/metpy.calc.downdraft_cape.html index 0857c5cb2cb..686f38a7c3e 100644 --- a/dev/api/generated/metpy.calc.downdraft_cape.html +++ b/dev/api/generated/metpy.calc.downdraft_cape.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -939,7 +939,7 @@

    downdraft_cape

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.dry_lapse.html b/dev/api/generated/metpy.calc.dry_lapse.html index 84c75eca573..5b86713a9a3 100644 --- a/dev/api/generated/metpy.calc.dry_lapse.html +++ b/dev/api/generated/metpy.calc.dry_lapse.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -914,7 +914,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.dry_static_energy.html b/dev/api/generated/metpy.calc.dry_static_energy.html index 11d11362ba9..63955c34da3 100644 --- a/dev/api/generated/metpy.calc.dry_static_energy.html +++ b/dev/api/generated/metpy.calc.dry_static_energy.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -903,7 +903,7 @@

    dry_static_energy

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.el.html b/dev/api/generated/metpy.calc.el.html index 907fc219b55..245e5130039 100644 --- a/dev/api/generated/metpy.calc.el.html +++ b/dev/api/generated/metpy.calc.el.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,7 +791,7 @@

    el#

  • dewpoint (pint.Quantity) – Dewpoint at the levels given by pressure

  • parcel_temperature_profile (pint.Quantity, optional) – The parcel’s temperature profile from which to calculate the EL. Defaults to the surface parcel profile.

    • -

  • which (str, optional) – Pick which EL to return. Options are ‘top’, ‘bottom’, ‘wide’, ‘most_cape’, and ‘all’. +

  • which (str, optional) – Pick which EL to return. Options are ‘top’, ‘bottom’, ‘wide’, ‘most_cape’, and ‘all’. ‘top’ returns the lowest-pressure EL, default. ‘bottom’ returns the highest-pressure EL. ‘wide’ returns the EL whose corresponding LFC is farthest away. @@ -938,7 +938,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.equivalent_potential_temperature.html b/dev/api/generated/metpy.calc.equivalent_potential_temperature.html index 3358cc76d2f..5efbaf52326 100644 --- a/dev/api/generated/metpy.calc.equivalent_potential_temperature.html +++ b/dev/api/generated/metpy.calc.equivalent_potential_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -912,7 +912,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.exner_function.html b/dev/api/generated/metpy.calc.exner_function.html index 251775324c9..3029a49e38a 100644 --- a/dev/api/generated/metpy.calc.exner_function.html +++ b/dev/api/generated/metpy.calc.exner_function.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -891,7 +891,7 @@

    exner_function

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.find_bounding_indices.html b/dev/api/generated/metpy.calc.find_bounding_indices.html index ec901f6831a..23f776f7014 100644 --- a/dev/api/generated/metpy.calc.find_bounding_indices.html +++ b/dev/api/generated/metpy.calc.find_bounding_indices.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -790,8 +790,8 @@

    find_bounding_indices @@ -892,7 +892,7 @@

    find_bounding_indices

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.find_intersections.html b/dev/api/generated/metpy.calc.find_intersections.html index 081abed0e3a..fe8ca89b58d 100644 --- a/dev/api/generated/metpy.calc.find_intersections.html +++ b/dev/api/generated/metpy.calc.find_intersections.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -788,9 +788,9 @@

    find_intersectionsstr, optional) – specifies direction of crossing. ‘all’, ‘increasing’ (a becoming greater than b), +

  • direction (str, optional) – specifies direction of crossing. ‘all’, ‘increasing’ (a becoming greater than b), or ‘decreasing’ (b becoming greater than a). Defaults to ‘all’.

    • -

  • log_x (bool, optional) – Use logarithmic interpolation along the x axis (i.e. for finding intersections +

  • log_x (bool, optional) – Use logarithmic interpolation along the x axis (i.e. for finding intersections in pressure coordinates). Default is False.

    • @@ -893,7 +893,7 @@

    find_intersections

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.first_derivative.html b/dev/api/generated/metpy.calc.first_derivative.html index b863f72cfce..73ebb69b8aa 100644 --- a/dev/api/generated/metpy.calc.first_derivative.html +++ b/dev/api/generated/metpy.calc.first_derivative.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,7 +794,7 @@

    first_derivativeParameters:

    • f (array-like) – Array of values of which to calculate the derivative

      • -

    • axis (int or str, optional) – The array axis along which to take the derivative. If f is ndarray-like, must be an +

    • axis (int or str, optional) – The array axis along which to take the derivative. If f is ndarray-like, must be an integer. If f is a DataArray, can be a string (referring to either the coordinate dimension name or the axis type) or integer (referring to axis number), unless using implicit conversion to pint.Quantity, in which case it must be an integer. Defaults @@ -904,7 +904,7 @@

      first_derivative

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.friction_velocity.html b/dev/api/generated/metpy.calc.friction_velocity.html index 160106f83ae..000051ac53f 100644 --- a/dev/api/generated/metpy.calc.friction_velocity.html +++ b/dev/api/generated/metpy.calc.friction_velocity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -789,11 +789,11 @@

      friction_velocitybool, optional) – True if the u, w, and v components of wind speed +

    • perturbation (bool, optional) – True if the u, w, and v components of wind speed supplied to the function are perturbation velocities. If False, perturbation velocities will be calculated by removing the mean value from each component.

      • -

    • axis (int) – The index of the time axis. Default is -1

      • +

    • axis (int) – The index of the time axis. Default is -1

    Returns:
    @@ -909,7 +909,7 @@

    friction_velocity

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.frontogenesis.html b/dev/api/generated/metpy.calc.frontogenesis.html index 5806ec16b87..156985f66b4 100644 --- a/dev/api/generated/metpy.calc.frontogenesis.html +++ b/dev/api/generated/metpy.calc.frontogenesis.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -804,9 +804,9 @@

    frontogenesispint.Quantity, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional if xarray.DataArray with latitude/longitude coordinates used as input.

    • -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -928,7 +928,7 @@

    frontogenesis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.galvez_davison_index.html b/dev/api/generated/metpy.calc.galvez_davison_index.html index f92ae2c73b6..2cdc47e18c9 100644 --- a/dev/api/generated/metpy.calc.galvez_davison_index.html +++ b/dev/api/generated/metpy.calc.galvez_davison_index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -834,7 +834,7 @@

    galvez_davison_index

    temperature (pint.Quantity) – Temperature corresponding to pressure

  • mixing_ratio (pint.Quantity) – Mixing ratio values corresponding to pressure

  • surface_pressure (pint.Quantity) – Pressure of the surface.

    • -

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    • @@ -960,7 +960,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.geopotential_to_height.html b/dev/api/generated/metpy.calc.geopotential_to_height.html index b07f88032b8..002a22202cb 100644 --- a/dev/api/generated/metpy.calc.geopotential_to_height.html +++ b/dev/api/generated/metpy.calc.geopotential_to_height.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -909,7 +909,7 @@

    geopotential_to_height

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.geospatial_gradient.html b/dev/api/generated/metpy.calc.geospatial_gradient.html index a583dd16103..f8bcfaabcb9 100644 --- a/dev/api/generated/metpy.calc.geospatial_gradient.html +++ b/dev/api/generated/metpy.calc.geospatial_gradient.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,7 +784,7 @@

    geospatial_gradientParameters:

    • f ((…, M, N) xarray.DataArray or pint.Quantity) – scalar field for which the horizontal gradient should be calculated

      • -

    • return_only (str or Sequence[str], optional) – Sequence of which components of the gradient to compute and return. If none, +

    • return_only (str or Sequence[str], optional) – Sequence of which components of the gradient to compute and return. If none, returns the gradient tuple (‘df/dx’, ‘df/dy’). Otherwise, matches the return pattern of the given strings. Only valid strings are ‘df/dx’, ‘df/dy’.

    • dx (pint.Quantity, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than @@ -797,9 +797,9 @@

      geospatial_gradientint, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

    • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

      • -

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

    • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -919,7 +919,7 @@

      geospatial_gradient

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.geospatial_laplacian.html b/dev/api/generated/metpy.calc.geospatial_laplacian.html index 282ce04c4c1..911a20e74ca 100644 --- a/dev/api/generated/metpy.calc.geospatial_laplacian.html +++ b/dev/api/generated/metpy.calc.geospatial_laplacian.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,7 +784,7 @@

      geospatial_laplacianParameters:

      • f ((…, M, N) xarray.DataArray or pint.Quantity) – scalar field for which the horizontal gradient should be calculated

        • -

      • return_only (str or Sequence[str], optional) – Sequence of which components of the gradient to compute and return. If none, +

      • return_only (str or Sequence[str], optional) – Sequence of which components of the gradient to compute and return. If none, returns the gradient tuple (‘df/dx’, ‘df/dy’). Otherwise, matches the return pattern of the given strings. Only valid strings are ‘df/dx’, ‘df/dy’.

      • dx (pint.Quantity, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than @@ -797,9 +797,9 @@

        geospatial_laplacian

        • -

      • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

      • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

        • -

      • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

      • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

      • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -919,7 +919,7 @@

        geospatial_laplacian

        - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

        diff --git a/dev/api/generated/metpy.calc.geostrophic_wind.html b/dev/api/generated/metpy.calc.geostrophic_wind.html index a83d1a8c6b9..61d0bdf8915 100644 --- a/dev/api/generated/metpy.calc.geostrophic_wind.html +++ b/dev/api/generated/metpy.calc.geostrophic_wind.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,9 +794,9 @@

        geostrophic_windxarray.DataArray with latitude coordinate used as input. Note that an argument without units is treated as dimensionless, which is equivalent to radians.

        • -

      • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

      • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

        • -

      • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

      • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

      • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -918,7 +918,7 @@

        Examples using

        - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

        diff --git a/dev/api/generated/metpy.calc.get_layer.html b/dev/api/generated/metpy.calc.get_layer.html index ddbf0241438..ce679a114fd 100644 --- a/dev/api/generated/metpy.calc.get_layer.html +++ b/dev/api/generated/metpy.calc.get_layer.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -796,7 +796,7 @@

        get_layerpint.Quantity, optional) – Thickness of the layer as a pressure or height above the bottom of the layer. Defaults to 100 hPa.

        • -

      • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data. Defaults +

      • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data. Defaults to True.

      @@ -898,7 +898,7 @@

      get_layer

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.get_layer_heights.html b/dev/api/generated/metpy.calc.get_layer_heights.html index 66737cdaf90..974d3285cde 100644 --- a/dev/api/generated/metpy.calc.get_layer_heights.html +++ b/dev/api/generated/metpy.calc.get_layer_heights.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -789,9 +789,9 @@

      get_layer_heightspint.Quantity) – Thickness of the layer

    • args (array-like) – Atmospheric variable(s) measured at the given pressures

    • bottom (pint.Quantity, optional) – Bottom of the layer

      • -

    • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data. Defaults +

    • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data. Defaults to True.

      • -

    • with_agl (bool, optional) – Returns the height as above ground level by subtracting the minimum height in the +

    • with_agl (bool, optional) – Returns the height as above ground level by subtracting the minimum height in the provided height. Defaults to False.

    @@ -893,7 +893,7 @@

    get_layer_heights

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.get_perturbation.html b/dev/api/generated/metpy.calc.get_perturbation.html index fb5f0a79a08..7d071987ae8 100644 --- a/dev/api/generated/metpy.calc.get_perturbation.html +++ b/dev/api/generated/metpy.calc.get_perturbation.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -786,7 +786,7 @@

    get_perturbation
    Returns:
    @@ -886,7 +886,7 @@

    get_perturbation

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.gradient.html b/dev/api/generated/metpy.calc.gradient.html index c2ab1a0faaf..5f63a9a8476 100644 --- a/dev/api/generated/metpy.calc.gradient.html +++ b/dev/api/generated/metpy.calc.gradient.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,7 +791,7 @@

    gradient
    Parameters:

    • f (array-like) – Array of values of which to calculate the derivative

      • -

    • axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray and implicit conversion to +

    • axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray and implicit conversion to pint.Quantity is not used) or integers that specify the array axes along which to take the derivatives. Defaults to all axes of f. If given, and used with coordinates or deltas, its length must be less than or equal to that of the @@ -917,7 +917,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.gradient_richardson_number.html b/dev/api/generated/metpy.calc.gradient_richardson_number.html index e0be4ec9447..abe71b5acf6 100644 --- a/dev/api/generated/metpy.calc.gradient_richardson_number.html +++ b/dev/api/generated/metpy.calc.gradient_richardson_number.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -793,7 +793,7 @@

      gradient_richardson_numberpint.Quantity) – Atmospheric potential temperature

    • u (pint.Quantity) – X component of the wind

    • v (pint.Quantity) – y component of the wind

      • -

    • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

    • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    @@ -889,7 +889,7 @@

    gradient_richardson_number

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.heat_index.html b/dev/api/generated/metpy.calc.heat_index.html index 7c752b5726a..1fa0266353d 100644 --- a/dev/api/generated/metpy.calc.heat_index.html +++ b/dev/api/generated/metpy.calc.heat_index.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,7 +791,7 @@

    heat_indexpint.Quantity) – Air temperature

  • relative_humidity (pint.Quantity) – The relative humidity expressed as a unitless ratio in the range [0, 1]. Can also pass a percentage if proper units are attached.

    • -

  • mask_undefined (bool, optional) – A flag indicating whether a masked array should be returned with +

  • mask_undefined (bool, optional) – A flag indicating whether a masked array should be returned with values masked where the temperature < 80F. Defaults to True.

    • @@ -907,7 +907,7 @@

    heat_index

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.height_to_geopotential.html b/dev/api/generated/metpy.calc.height_to_geopotential.html index b5e6e68f8e9..1ffc212551a 100644 --- a/dev/api/generated/metpy.calc.height_to_geopotential.html +++ b/dev/api/generated/metpy.calc.height_to_geopotential.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -908,7 +908,7 @@

    height_to_geopotential

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.height_to_pressure_std.html b/dev/api/generated/metpy.calc.height_to_pressure_std.html index 1839c2f044a..67623bba7e6 100644 --- a/dev/api/generated/metpy.calc.height_to_pressure_std.html +++ b/dev/api/generated/metpy.calc.height_to_pressure_std.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -881,7 +881,7 @@

    height_to_pressure_std

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.html b/dev/api/generated/metpy.calc.html index 81371894034..ba26147afc6 100644 --- a/dev/api/generated/metpy.calc.html +++ b/dev/api/generated/metpy.calc.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -1390,7 +1390,7 @@

    Other#<

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.inertial_advective_wind.html b/dev/api/generated/metpy.calc.inertial_advective_wind.html index 251b39bdc5b..ad261254467 100644 --- a/dev/api/generated/metpy.calc.inertial_advective_wind.html +++ b/dev/api/generated/metpy.calc.inertial_advective_wind.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -809,9 +809,9 @@

    inertial_advective_wind

    latitude (pint.Quantity, optional) – Latitude of the wind data. Optional if xarray.DataArray with latitude/longitude coordinates used as input. Note that an argument without units is treated as dimensionless, which translates to radians.

    -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -934,7 +934,7 @@

    inertial_advective_wind

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.isentropic_interpolation.html b/dev/api/generated/metpy.calc.isentropic_interpolation.html index 43be2b86df4..0ff52d15d6e 100644 --- a/dev/api/generated/metpy.calc.isentropic_interpolation.html +++ b/dev/api/generated/metpy.calc.isentropic_interpolation.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,12 +787,12 @@

    isentropic_interpolationint, optional) – The axis corresponding to the vertical in the temperature array, defaults to 0.

    • -

  • temperature_out (bool, optional) – If true, will calculate temperature and output as the last item in the output list. +

  • vertical_dim (int, optional) – The axis corresponding to the vertical in the temperature array, defaults to 0.

    • +

  • temperature_out (bool, optional) – If true, will calculate temperature and output as the last item in the output list. Defaults to False.

    • -

  • max_iters (int, optional) – Maximum number of iterations to use in calculation, defaults to 50.

    • -

  • eps (float, optional) – The desired absolute error in the calculated value, defaults to 1e-6.

    • -

  • bottom_up_search (bool, optional) – Controls whether to search for levels bottom-up (starting at lower indices), +

  • max_iters (int, optional) – Maximum number of iterations to use in calculation, defaults to 50.

    • +

  • eps (float, optional) – The desired absolute error in the calculated value, defaults to 1e-6.

    • +

  • bottom_up_search (bool, optional) – Controls whether to search for levels bottom-up (starting at lower indices), or top-down (starting at higher indices). Defaults to True, which is bottom-up search.

    • @@ -905,7 +905,7 @@

    isentropic_interpolation

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.isentropic_interpolation_as_dataset.html b/dev/api/generated/metpy.calc.isentropic_interpolation_as_dataset.html index ff6ef5e35ef..2042d7e8102 100644 --- a/dev/api/generated/metpy.calc.isentropic_interpolation_as_dataset.html +++ b/dev/api/generated/metpy.calc.isentropic_interpolation_as_dataset.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,9 +787,9 @@

    isentropic_interpolation_as_datasetxarray.DataArray) – Array of temperature

  • args (xarray.DataArray, optional) – Any other given variables will be interpolated to each isentropic level. Must have names in order to have a well-formed output Dataset.

    • -

  • max_iters (int, optional) – The maximum number of iterations to use in calculation, defaults to 50.

    • -

  • eps (float, optional) – The desired absolute error in the calculated value, defaults to 1e-6.

    • -

  • bottom_up_search (bool, optional) – Controls whether to search for levels bottom-up (starting at lower indices), +

  • max_iters (int, optional) – The maximum number of iterations to use in calculation, defaults to 50.

    • +

  • eps (float, optional) – The desired absolute error in the calculated value, defaults to 1e-6.

    • +

  • bottom_up_search (bool, optional) – Controls whether to search for levels bottom-up (starting at lower indices), or top-down (starting at higher indices). Defaults to True, which is bottom-up search.

  • pressure (xarray.DataArray, optional) – Array of pressure to use when the vertical coordinate for the passed in data is not pressure (e.g. data using sigma coordinates)

    • @@ -908,7 +908,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.k_index.html b/dev/api/generated/metpy.calc.k_index.html index 596733c6c14..32fcdf4ae5d 100644 --- a/dev/api/generated/metpy.calc.k_index.html +++ b/dev/api/generated/metpy.calc.k_index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -801,7 +801,7 @@

    k_index#<

  • pressure (pint.Quantity) – Pressure level(s), in order from highest to lowest pressure

  • temperature (pint.Quantity) – Temperature corresponding to pressure

  • dewpoint (pint.Quantity) – Dewpoint temperature corresponding to pressure

    • -

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    • @@ -930,7 +930,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.kinematic_flux.html b/dev/api/generated/metpy.calc.kinematic_flux.html index 3fd4c86820a..e241e657748 100644 --- a/dev/api/generated/metpy.calc.kinematic_flux.html +++ b/dev/api/generated/metpy.calc.kinematic_flux.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -789,9 +789,9 @@

    kinematic_flux @@ -909,7 +909,7 @@

    kinematic_flux

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.laplacian.html b/dev/api/generated/metpy.calc.laplacian.html index 28728ba1967..19f9731caa8 100644 --- a/dev/api/generated/metpy.calc.laplacian.html +++ b/dev/api/generated/metpy.calc.laplacian.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,7 +791,7 @@

    laplacianParameters:

    • f (array-like) – Array of values of which to calculate the derivative

      • -

    • axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray and implicit conversion to +

    • axes (Sequence[str] or Sequence[int], optional) – Sequence of strings (if f is a xarray.DataArray and implicit conversion to pint.Quantity is not used) or integers that specify the array axes along which to take the derivatives. Defaults to all axes of f. If given, and used with coordinates or deltas, its length must be less than or equal to that of the @@ -905,7 +905,7 @@

      laplacian

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html b/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html index f3c8bae7dbe..e4ee28d64c8 100644 --- a/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html +++ b/dev/api/generated/metpy.calc.lat_lon_grid_deltas.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,8 +787,8 @@

      lat_lon_grid_deltaspint.Quantity, assumed to be in degrees.

      • -

    • x_dim (int) – axis number for the x dimension, defaults to -1.

      • -

    • y_dim (int) – axis number for the y dimension, defaults to -2.

      • +

    • x_dim (int) – axis number for the x dimension, defaults to -1.

      • +

    • y_dim (int) – axis number for the y dimension, defaults to -2.

    • geod (pyproj.Geod or None) – PyProj Geod to use for forward azimuth and distance calculations. If None, use a default spherical ellipsoid.

    @@ -895,7 +895,7 @@

    lat_lon_grid_deltas

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.lcl.html b/dev/api/generated/metpy.calc.lcl.html index 40d8d495b09..8e9637a923b 100644 --- a/dev/api/generated/metpy.calc.lcl.html +++ b/dev/api/generated/metpy.calc.lcl.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -789,8 +789,8 @@

    lcl#

  • pressure (pint.Quantity) – Starting atmospheric pressure

  • temperature (pint.Quantity) – Starting temperature

  • dewpoint (pint.Quantity) – Starting dewpoint

    • -

  • max_iters (int, optional) – The maximum number of iterations to use in calculation, defaults to 50.

    • -

  • eps (float, optional) – The desired relative error in the calculated value, defaults to 1e-5.

    • +

  • max_iters (int, optional) – The maximum number of iterations to use in calculation, defaults to 50.

    • +

  • eps (float, optional) – The desired relative error in the calculated value, defaults to 1e-5.

    • Returns:
    @@ -931,7 +931,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.lfc.html b/dev/api/generated/metpy.calc.lfc.html index 57dae2a6a94..a2812962a3e 100644 --- a/dev/api/generated/metpy.calc.lfc.html +++ b/dev/api/generated/metpy.calc.lfc.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -795,7 +795,7 @@

    lfc#

    surface parcel profile.

  • dewpoint_start (pint.Quantity, optional) – Dewpoint of the parcel for which to calculate the LFC. Defaults to the surface dewpoint.

    • -

  • which (str, optional) – Pick which LFC to return. Options are ‘top’, ‘bottom’, ‘wide’, ‘most_cape’, and ‘all’; +

  • which (str, optional) – Pick which LFC to return. Options are ‘top’, ‘bottom’, ‘wide’, ‘most_cape’, and ‘all’; ‘top’ returns the lowest-pressure LFC (default), ‘bottom’ returns the highest-pressure LFC, ‘wide’ returns the LFC whose corresponding EL is farthest away, @@ -940,7 +940,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.lifted_index.html b/dev/api/generated/metpy.calc.lifted_index.html index e4a3c3a5e31..73893b5c1f2 100644 --- a/dev/api/generated/metpy.calc.lifted_index.html +++ b/dev/api/generated/metpy.calc.lifted_index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -800,7 +800,7 @@

    lifted_indexpint.Quantity) – Atmospheric temperature corresponding to pressure

  • parcel_profile (pint.Quantity) – Temperature profile of the parcel

    • -

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    • @@ -938,7 +938,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mean_pressure_weighted.html b/dev/api/generated/metpy.calc.mean_pressure_weighted.html index e7f8027bb96..1fcff56f223 100644 --- a/dev/api/generated/metpy.calc.mean_pressure_weighted.html +++ b/dev/api/generated/metpy.calc.mean_pressure_weighted.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -924,7 +924,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mixed_layer.html b/dev/api/generated/metpy.calc.mixed_layer.html index fd122f03129..77ec47b4208 100644 --- a/dev/api/generated/metpy.calc.mixed_layer.html +++ b/dev/api/generated/metpy.calc.mixed_layer.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -792,7 +792,7 @@

    mixed_layerpint.Quantity, optional) – The thickness of the layer as a pressure or height above the bottom of the layer (default 100 hPa)

    -

  • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data (default True)

    • +

  • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data (default True)

    • Returns:
    @@ -928,7 +928,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mixed_layer_cape_cin.html b/dev/api/generated/metpy.calc.mixed_layer_cape_cin.html index f15b1877e23..df0165a00f5 100644 --- a/dev/api/generated/metpy.calc.mixed_layer_cape_cin.html +++ b/dev/api/generated/metpy.calc.mixed_layer_cape_cin.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -932,7 +932,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mixed_parcel.html b/dev/api/generated/metpy.calc.mixed_parcel.html index 4529957f583..ba1256332bc 100644 --- a/dev/api/generated/metpy.calc.mixed_parcel.html +++ b/dev/api/generated/metpy.calc.mixed_parcel.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,7 +794,7 @@

    mixed_parcelpint.Quantity, optional) – The thickness of the layer as a pressure or height above the bottom of the layer (default 100 hPa)

    -

  • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data

    • +

  • interpolate (bool, optional) – Interpolate the top and bottom points if they are not in the given data

    • Returns:
    @@ -937,7 +937,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mixing_ratio.html b/dev/api/generated/metpy.calc.mixing_ratio.html index b58b368f18b..c723f2f89bd 100644 --- a/dev/api/generated/metpy.calc.mixing_ratio.html +++ b/dev/api/generated/metpy.calc.mixing_ratio.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -905,7 +905,7 @@

    mixing_ratio

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mixing_ratio_from_relative_humidity.html b/dev/api/generated/metpy.calc.mixing_ratio_from_relative_humidity.html index 682349d5ab0..cc0299a08f4 100644 --- a/dev/api/generated/metpy.calc.mixing_ratio_from_relative_humidity.html +++ b/dev/api/generated/metpy.calc.mixing_ratio_from_relative_humidity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -922,7 +922,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.mixing_ratio_from_specific_humidity.html b/dev/api/generated/metpy.calc.mixing_ratio_from_specific_humidity.html index 4f7279fece6..8908c50ffc9 100644 --- a/dev/api/generated/metpy.calc.mixing_ratio_from_specific_humidity.html +++ b/dev/api/generated/metpy.calc.mixing_ratio_from_specific_humidity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -898,7 +898,7 @@

    mixing_ratio_from_specific_humidity

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.moist_lapse.html b/dev/api/generated/metpy.calc.moist_lapse.html index 381a1640f3b..1091f95629c 100644 --- a/dev/api/generated/metpy.calc.moist_lapse.html +++ b/dev/api/generated/metpy.calc.moist_lapse.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -922,7 +922,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.moist_static_energy.html b/dev/api/generated/metpy.calc.moist_static_energy.html index 5e0cb1abcb1..4e8f82e9798 100644 --- a/dev/api/generated/metpy.calc.moist_static_energy.html +++ b/dev/api/generated/metpy.calc.moist_static_energy.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -901,7 +901,7 @@

    moist_static_energy

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.montgomery_streamfunction.html b/dev/api/generated/metpy.calc.montgomery_streamfunction.html index f754769256d..efbb55ed172 100644 --- a/dev/api/generated/metpy.calc.montgomery_streamfunction.html +++ b/dev/api/generated/metpy.calc.montgomery_streamfunction.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -905,7 +905,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.most_unstable_cape_cin.html b/dev/api/generated/metpy.calc.most_unstable_cape_cin.html index e1130afd22b..0763e90a57f 100644 --- a/dev/api/generated/metpy.calc.most_unstable_cape_cin.html +++ b/dev/api/generated/metpy.calc.most_unstable_cape_cin.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -932,7 +932,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.most_unstable_parcel.html b/dev/api/generated/metpy.calc.most_unstable_parcel.html index c337a1e5190..501d2c3eef3 100644 --- a/dev/api/generated/metpy.calc.most_unstable_parcel.html +++ b/dev/api/generated/metpy.calc.most_unstable_parcel.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -939,7 +939,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.nearest_intersection_idx.html b/dev/api/generated/metpy.calc.nearest_intersection_idx.html index 37fafb4dade..a13bc02bc95 100644 --- a/dev/api/generated/metpy.calc.nearest_intersection_idx.html +++ b/dev/api/generated/metpy.calc.nearest_intersection_idx.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -883,7 +883,7 @@

    nearest_intersection_idx

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.normal_component.html b/dev/api/generated/metpy.calc.normal_component.html index 1cfeda72c94..bfadca63707 100644 --- a/dev/api/generated/metpy.calc.normal_component.html +++ b/dev/api/generated/metpy.calc.normal_component.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,7 +787,7 @@

    normal_componentxarray.DataArray) – The input DataArray of the y-component (in terms of data projection) of the vector field.

    -

  • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as +

  • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as set by metpy.interpolate.cross_section

    • @@ -889,7 +889,7 @@

    normal_component

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.parcel_profile.html b/dev/api/generated/metpy.calc.parcel_profile.html index a33512dbc7c..42f87c08ce3 100644 --- a/dev/api/generated/metpy.calc.parcel_profile.html +++ b/dev/api/generated/metpy.calc.parcel_profile.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -943,7 +943,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.parcel_profile_with_lcl.html b/dev/api/generated/metpy.calc.parcel_profile_with_lcl.html index f097d7d2834..47fd07ce86b 100644 --- a/dev/api/generated/metpy.calc.parcel_profile_with_lcl.html +++ b/dev/api/generated/metpy.calc.parcel_profile_with_lcl.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -932,7 +932,7 @@

    parcel_profile_with_lcl

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.parcel_profile_with_lcl_as_dataset.html b/dev/api/generated/metpy.calc.parcel_profile_with_lcl_as_dataset.html index 264b54caaef..1a4daeef1c6 100644 --- a/dev/api/generated/metpy.calc.parcel_profile_with_lcl_as_dataset.html +++ b/dev/api/generated/metpy.calc.parcel_profile_with_lcl_as_dataset.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -902,7 +902,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.parse_angle.html b/dev/api/generated/metpy.calc.parse_angle.html index e9b7094d6de..b46f10fd94a 100644 --- a/dev/api/generated/metpy.calc.parse_angle.html +++ b/dev/api/generated/metpy.calc.parse_angle.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,7 +784,7 @@

    parse_angle
    Parameters:
    -

    input_dir (str or Sequence[str]) – Directional text such as west, [south-west, ne], etc.

    +

    input_dir (str or Sequence[str]) – Directional text such as west, [south-west, ne], etc.

    Returns:

    pint.Quantity – The angle in degrees

    @@ -888,7 +888,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.potential_temperature.html b/dev/api/generated/metpy.calc.potential_temperature.html index 94855995e87..c467e0e4695 100644 --- a/dev/api/generated/metpy.calc.potential_temperature.html +++ b/dev/api/generated/metpy.calc.potential_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -903,7 +903,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.potential_vorticity_baroclinic.html b/dev/api/generated/metpy.calc.potential_vorticity_baroclinic.html index b916ee9bc6f..37e8b6cd341 100644 --- a/dev/api/generated/metpy.calc.potential_vorticity_baroclinic.html +++ b/dev/api/generated/metpy.calc.potential_vorticity_baroclinic.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -802,11 +802,11 @@

    potential_vorticity_baroclinicpint.Quantity, optional) – Latitude of the wind data. Optional if xarray.DataArray with latitude/longitude coordinates used as input. Note that an argument without units is treated as dimensionless, which translates to radians.

    -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Z, Y, X] order). +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Z, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Z, Y, X] order). +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Z, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • vertical_dim (int, optional) – Axis number of vertical dimension. Defaults to -3 (implying […, Z, Y, X] order). +

  • vertical_dim (int, optional) – Axis number of vertical dimension. Defaults to -3 (implying […, Z, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -932,7 +932,7 @@

    potential_vorticity_baroclinic

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.potential_vorticity_barotropic.html b/dev/api/generated/metpy.calc.potential_vorticity_barotropic.html index 154181e7da0..b59594af312 100644 --- a/dev/api/generated/metpy.calc.potential_vorticity_barotropic.html +++ b/dev/api/generated/metpy.calc.potential_vorticity_barotropic.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -799,9 +799,9 @@

    potential_vorticity_barotropicpint.Quantity, optional) – Latitude of the wind data. Optional if xarray.DataArray with latitude/longitude coordinates used as input. Note that an argument without units is treated as dimensionless, which translates to radians.

    • -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -916,7 +916,7 @@

    potential_vorticity_barotropic

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.precipitable_water.html b/dev/api/generated/metpy.calc.precipitable_water.html index f04829dbf55..3c7f1d3f5d6 100644 --- a/dev/api/generated/metpy.calc.precipitable_water.html +++ b/dev/api/generated/metpy.calc.precipitable_water.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -897,7 +897,7 @@

    precipitable_water

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.pressure_to_height_std.html b/dev/api/generated/metpy.calc.pressure_to_height_std.html index 9e3d9d43370..081cc4034b2 100644 --- a/dev/api/generated/metpy.calc.pressure_to_height_std.html +++ b/dev/api/generated/metpy.calc.pressure_to_height_std.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -881,7 +881,7 @@

    pressure_to_height_std

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.psychrometric_vapor_pressure_wet.html b/dev/api/generated/metpy.calc.psychrometric_vapor_pressure_wet.html index 61b18f15e18..6b738967225 100644 --- a/dev/api/generated/metpy.calc.psychrometric_vapor_pressure_wet.html +++ b/dev/api/generated/metpy.calc.psychrometric_vapor_pressure_wet.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -918,7 +918,7 @@

    psychrometric_vapor_pressure_wet

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.q_vector.html b/dev/api/generated/metpy.calc.q_vector.html index a214b96cacf..df07ca549c6 100644 --- a/dev/api/generated/metpy.calc.q_vector.html +++ b/dev/api/generated/metpy.calc.q_vector.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -810,9 +810,9 @@

    q_vector latitude/longitude coordinates used as input.

  • static_stability (pint.Quantity, optional) – The static stability at the pressure level. Defaults to 1 if not given to calculate the Q-vector without factoring in static stability.

    • -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -942,7 +942,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.reduce_point_density.html b/dev/api/generated/metpy.calc.reduce_point_density.html index 912f17a2866..a97d39fba19 100644 --- a/dev/api/generated/metpy.calc.reduce_point_density.html +++ b/dev/api/generated/metpy.calc.reduce_point_density.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -911,7 +911,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.relative_humidity_from_dewpoint.html b/dev/api/generated/metpy.calc.relative_humidity_from_dewpoint.html index 5ac9f2a0295..eb0431bc030 100644 --- a/dev/api/generated/metpy.calc.relative_humidity_from_dewpoint.html +++ b/dev/api/generated/metpy.calc.relative_humidity_from_dewpoint.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -909,7 +909,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.relative_humidity_from_mixing_ratio.html b/dev/api/generated/metpy.calc.relative_humidity_from_mixing_ratio.html index bb4aa781adb..b869af20468 100644 --- a/dev/api/generated/metpy.calc.relative_humidity_from_mixing_ratio.html +++ b/dev/api/generated/metpy.calc.relative_humidity_from_mixing_ratio.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -907,7 +907,7 @@

    relative_humidity_from_mixing_ratio

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.relative_humidity_from_specific_humidity.html b/dev/api/generated/metpy.calc.relative_humidity_from_specific_humidity.html index a903312348a..fafae01a6a2 100644 --- a/dev/api/generated/metpy.calc.relative_humidity_from_specific_humidity.html +++ b/dev/api/generated/metpy.calc.relative_humidity_from_specific_humidity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -919,7 +919,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.relative_humidity_wet_psychrometric.html b/dev/api/generated/metpy.calc.relative_humidity_wet_psychrometric.html index 64a4c557f25..9cc8a155a00 100644 --- a/dev/api/generated/metpy.calc.relative_humidity_wet_psychrometric.html +++ b/dev/api/generated/metpy.calc.relative_humidity_wet_psychrometric.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -907,7 +907,7 @@

    relative_humidity_wet_psychrometric

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.resample_nn_1d.html b/dev/api/generated/metpy.calc.resample_nn_1d.html index e23868729b2..150533770a3 100644 --- a/dev/api/generated/metpy.calc.resample_nn_1d.html +++ b/dev/api/generated/metpy.calc.resample_nn_1d.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -894,7 +894,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.saturation_equivalent_potential_temperature.html b/dev/api/generated/metpy.calc.saturation_equivalent_potential_temperature.html index 00cabeed5e0..6ad8204fa19 100644 --- a/dev/api/generated/metpy.calc.saturation_equivalent_potential_temperature.html +++ b/dev/api/generated/metpy.calc.saturation_equivalent_potential_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -915,7 +915,7 @@

    saturation_equivalent_potential_temperature

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.saturation_mixing_ratio.html b/dev/api/generated/metpy.calc.saturation_mixing_ratio.html index a25417a78b6..b0fddf54dd2 100644 --- a/dev/api/generated/metpy.calc.saturation_mixing_ratio.html +++ b/dev/api/generated/metpy.calc.saturation_mixing_ratio.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -896,7 +896,7 @@

    saturation_mixing_ratio

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.saturation_vapor_pressure.html b/dev/api/generated/metpy.calc.saturation_vapor_pressure.html index f5ce57e6600..d15bfb80490 100644 --- a/dev/api/generated/metpy.calc.saturation_vapor_pressure.html +++ b/dev/api/generated/metpy.calc.saturation_vapor_pressure.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -894,7 +894,7 @@

    saturation_vapor_pressure

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.scale_height.html b/dev/api/generated/metpy.calc.scale_height.html index f721c079ebb..659dbf44891 100644 --- a/dev/api/generated/metpy.calc.scale_height.html +++ b/dev/api/generated/metpy.calc.scale_height.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -891,7 +891,7 @@

    scale_height

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.second_derivative.html b/dev/api/generated/metpy.calc.second_derivative.html index f10126545e4..9b9d8fdbc6f 100644 --- a/dev/api/generated/metpy.calc.second_derivative.html +++ b/dev/api/generated/metpy.calc.second_derivative.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,7 +794,7 @@

    second_derivativeParameters:

    • f (array-like) – Array of values of which to calculate the derivative

      • -

    • axis (int or str, optional) – The array axis along which to take the derivative. If f is ndarray-like, must be an +

    • axis (int or str, optional) – The array axis along which to take the derivative. If f is ndarray-like, must be an integer. If f is a DataArray, can be a string (referring to either the coordinate dimension name or the axis type) or integer (referring to axis number), unless using implicit conversion to pint.Quantity, in which case it must be an integer. Defaults @@ -904,7 +904,7 @@

      second_derivative

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.shearing_deformation.html b/dev/api/generated/metpy.calc.shearing_deformation.html index d52c7dfb185..7a59c88d17c 100644 --- a/dev/api/generated/metpy.calc.shearing_deformation.html +++ b/dev/api/generated/metpy.calc.shearing_deformation.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,9 +791,9 @@

      shearing_deformation

      dy (pint.Quantity, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional if xarray.DataArray with latitude/longitude coordinates used as input.

      • -

    • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

    • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

      • -

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -923,7 +923,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.showalter_index.html b/dev/api/generated/metpy.calc.showalter_index.html index cd06a547401..dd0e675758c 100644 --- a/dev/api/generated/metpy.calc.showalter_index.html +++ b/dev/api/generated/metpy.calc.showalter_index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -920,7 +920,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.sigma_to_pressure.html b/dev/api/generated/metpy.calc.sigma_to_pressure.html index 4596bb1a9a3..5c070e5fd30 100644 --- a/dev/api/generated/metpy.calc.sigma_to_pressure.html +++ b/dev/api/generated/metpy.calc.sigma_to_pressure.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -903,7 +903,7 @@

      sigma_to_pressure

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.significant_tornado.html b/dev/api/generated/metpy.calc.significant_tornado.html index 872ea92cb91..e533f3f1863 100644 --- a/dev/api/generated/metpy.calc.significant_tornado.html +++ b/dev/api/generated/metpy.calc.significant_tornado.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -914,7 +914,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.smooth_circular.html b/dev/api/generated/metpy.calc.smooth_circular.html index cdbf5c54373..02387563c10 100644 --- a/dev/api/generated/metpy.calc.smooth_circular.html +++ b/dev/api/generated/metpy.calc.smooth_circular.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,9 +785,9 @@

      smooth_circular

    Returns:
    @@ -900,7 +900,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.smooth_gaussian.html b/dev/api/generated/metpy.calc.smooth_gaussian.html index 1546fd3feaf..0e9424b2864 100644 --- a/dev/api/generated/metpy.calc.smooth_gaussian.html +++ b/dev/api/generated/metpy.calc.smooth_gaussian.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -786,7 +786,7 @@

    smooth_gaussian

    • scalar_grid (pint.Quantity) – Some n-dimensional scalar grid. If more than two axes, smoothing is only done across the last two.

      • -

    • n (int) – Degree of filtering

      • +

    • n (int) – Degree of filtering

    • Returns:
    @@ -940,7 +940,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.smooth_n_point.html b/dev/api/generated/metpy.calc.smooth_n_point.html index 25efe9179f2..47098faec66 100644 --- a/dev/api/generated/metpy.calc.smooth_n_point.html +++ b/dev/api/generated/metpy.calc.smooth_n_point.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,9 +785,9 @@

    smooth_n_point

    • scalar_grid (array-like or pint.Quantity) – N-dimensional scalar grid to be smoothed. If more than two axes, smoothing is only done along the last two.

      • -

    • n (int) – The number of points to use in smoothing, only valid inputs +

    • n (int) – The number of points to use in smoothing, only valid inputs are 5 and 9. Defaults to 5.

      • -

    • passes (int) – The number of times to apply the filter to the grid. Defaults to 1.

      • +

    • passes (int) – The number of times to apply the filter to the grid. Defaults to 1.

    Returns:
    @@ -902,7 +902,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.smooth_rectangular.html b/dev/api/generated/metpy.calc.smooth_rectangular.html index 2298431545e..14cd10df9f0 100644 --- a/dev/api/generated/metpy.calc.smooth_rectangular.html +++ b/dev/api/generated/metpy.calc.smooth_rectangular.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,8 +784,8 @@

    smooth_rectangularParameters:
    Returns:
    @@ -898,7 +898,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.smooth_window.html b/dev/api/generated/metpy.calc.smooth_window.html index 9d3ae7afa96..c9589ad0132 100644 --- a/dev/api/generated/metpy.calc.smooth_window.html +++ b/dev/api/generated/metpy.calc.smooth_window.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,8 +787,8 @@

    smooth_windownumpy.ndarray) – Window to use in smoothing. Can have dimension less than or equal to N. If dimension less than N, the scalar grid will be smoothed along its trailing dimensions. Shape along each dimension must be odd.

    -

  • passes (int) – The number of times to apply the filter to the grid. Defaults to 1.

    • -

  • normalize_weights (bool) – If true, divide the values in window by the sum of all values in the window to obtain +

  • passes (int) – The number of times to apply the filter to the grid. Defaults to 1.

    • +

  • normalize_weights (bool) – If true, divide the values in window by the sum of all values in the window to obtain the normalized smoothing weights. If false, use supplied values directly as the weights.

    • @@ -904,7 +904,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.specific_humidity_from_dewpoint.html b/dev/api/generated/metpy.calc.specific_humidity_from_dewpoint.html index efadef458f8..b2c6811a642 100644 --- a/dev/api/generated/metpy.calc.specific_humidity_from_dewpoint.html +++ b/dev/api/generated/metpy.calc.specific_humidity_from_dewpoint.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -893,7 +893,7 @@

    specific_humidity_from_dewpoint

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.specific_humidity_from_mixing_ratio.html b/dev/api/generated/metpy.calc.specific_humidity_from_mixing_ratio.html index a6ba5464c27..ce976a984ee 100644 --- a/dev/api/generated/metpy.calc.specific_humidity_from_mixing_ratio.html +++ b/dev/api/generated/metpy.calc.specific_humidity_from_mixing_ratio.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -896,7 +896,7 @@

    specific_humidity_from_mixing_ratio

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.static_stability.html b/dev/api/generated/metpy.calc.static_stability.html index e33801f8dbe..85daa2ff8c8 100644 --- a/dev/api/generated/metpy.calc.static_stability.html +++ b/dev/api/generated/metpy.calc.static_stability.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -789,7 +789,7 @@

    static_stability

    • pressure (pint.Quantity) – Profile of atmospheric pressure

    • temperature (pint.Quantity) – Profile of temperature

      • -

    • vertical_dim (int, optional) – The axis corresponding to vertical in the pressure and temperature arrays, defaults +

    • vertical_dim (int, optional) – The axis corresponding to vertical in the pressure and temperature arrays, defaults to 0.

    @@ -920,7 +920,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.storm_relative_helicity.html b/dev/api/generated/metpy.calc.storm_relative_helicity.html index ffa16b3235a..768d2548d59 100644 --- a/dev/api/generated/metpy.calc.storm_relative_helicity.html +++ b/dev/api/generated/metpy.calc.storm_relative_helicity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -794,10 +794,10 @@

    storm_relative_helicity

    u (array-like) – U component winds

  • v (array-like) – V component winds

  • height (array-like) – Atmospheric height, will be converted to AGL

    • -

  • depth (float or int) – Depth of the layer

    • -

  • bottom (float or int) – Height of layer bottom AGL (default is surface)

    • -

  • storm_u (float or int) – U component of storm motion (default is 0 m/s)

    • -

  • storm_v (float or int) – V component of storm motion (default is 0 m/s)

    • +

  • depth (float or int) – Depth of the layer

    • +

  • bottom (float or int) – Height of layer bottom AGL (default is surface)

    • +

  • storm_u (float or int) – U component of storm motion (default is 0 m/s)

    • +

  • storm_v (float or int) – V component of storm motion (default is 0 m/s)

    • Returns:
    @@ -933,7 +933,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.stretching_deformation.html b/dev/api/generated/metpy.calc.stretching_deformation.html index 1453d56663b..2dc3912ac45 100644 --- a/dev/api/generated/metpy.calc.stretching_deformation.html +++ b/dev/api/generated/metpy.calc.stretching_deformation.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,9 +791,9 @@

    stretching_deformation

    dy (pint.Quantity, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional if xarray.DataArray with latitude/longitude coordinates used as input.

    -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -923,7 +923,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.supercell_composite.html b/dev/api/generated/metpy.calc.supercell_composite.html index 8e89d510df0..a8f4327b691 100644 --- a/dev/api/generated/metpy.calc.supercell_composite.html +++ b/dev/api/generated/metpy.calc.supercell_composite.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -909,7 +909,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.surface_based_cape_cin.html b/dev/api/generated/metpy.calc.surface_based_cape_cin.html index 6b55032d824..4115df70ae1 100644 --- a/dev/api/generated/metpy.calc.surface_based_cape_cin.html +++ b/dev/api/generated/metpy.calc.surface_based_cape_cin.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -911,7 +911,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.sweat_index.html b/dev/api/generated/metpy.calc.sweat_index.html index 901b64d55fa..4e943251366 100644 --- a/dev/api/generated/metpy.calc.sweat_index.html +++ b/dev/api/generated/metpy.calc.sweat_index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -813,7 +813,7 @@

    sweat_indexpint.Quantity) – Dewpoint temperature corresponding to pressure

  • speed (pint.Quantity) – Wind speed corresponding to pressure

  • direction (pint.Quantity) – Wind direction corresponding to pressure

    • -

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    • @@ -909,7 +909,7 @@

    sweat_index

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.tangential_component.html b/dev/api/generated/metpy.calc.tangential_component.html index b6d65601fc8..63b602ff97f 100644 --- a/dev/api/generated/metpy.calc.tangential_component.html +++ b/dev/api/generated/metpy.calc.tangential_component.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,7 +787,7 @@

    tangential_component

  • data_y (xarray.DataArray) – The input DataArray of the y-component (in terms of data projection) of the vector field

    • -

  • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as +

  • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as set by metpy.interpolate.cross_section

    • @@ -889,7 +889,7 @@

    tangential_component

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.temperature_from_potential_temperature.html b/dev/api/generated/metpy.calc.temperature_from_potential_temperature.html index 8584bd9302c..a19bfe00352 100644 --- a/dev/api/generated/metpy.calc.temperature_from_potential_temperature.html +++ b/dev/api/generated/metpy.calc.temperature_from_potential_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -902,7 +902,7 @@

    temperature_from_potential_temperature

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.thickness_hydrostatic.html b/dev/api/generated/metpy.calc.thickness_hydrostatic.html index 2b9f2bf6787..f4bc2fa433c 100644 --- a/dev/api/generated/metpy.calc.thickness_hydrostatic.html +++ b/dev/api/generated/metpy.calc.thickness_hydrostatic.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -957,7 +957,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.thickness_hydrostatic_from_relative_humidity.html b/dev/api/generated/metpy.calc.thickness_hydrostatic_from_relative_humidity.html index 3eed7ad1799..c7020e84f08 100644 --- a/dev/api/generated/metpy.calc.thickness_hydrostatic_from_relative_humidity.html +++ b/dev/api/generated/metpy.calc.thickness_hydrostatic_from_relative_humidity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -928,7 +928,7 @@

    thickness_hydrostatic_from_relative_humidity

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.tke.html b/dev/api/generated/metpy.calc.tke.html index 06adb874005..f6914b05053 100644 --- a/dev/api/generated/metpy.calc.tke.html +++ b/dev/api/generated/metpy.calc.tke.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -789,11 +789,11 @@

    tke#

  • u (array-like) – The wind component along the x-axis

  • v (array-like) – The wind component along the y-axis

  • w (array-like) – The wind component along the z-axis

    • -

  • perturbation (bool, optional) – True if the u, v, and w components of wind speed +

  • perturbation (bool, optional) – True if the u, v, and w components of wind speed supplied to the function are perturbation velocities. If False, perturbation velocities will be calculated by removing the mean value from each component.

    • -

  • axis (int) – The index of the time axis. Default is -1

    • +

  • axis (int) – The index of the time axis. Default is -1

    • Returns:
    @@ -906,7 +906,7 @@

    tke#

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.total_deformation.html b/dev/api/generated/metpy.calc.total_deformation.html index 0c8cff8334b..682efe3cb67 100644 --- a/dev/api/generated/metpy.calc.total_deformation.html +++ b/dev/api/generated/metpy.calc.total_deformation.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,9 +791,9 @@

    total_deformationpint.Quantity, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional if xarray.DataArray with latitude/longitude coordinates used as input.

    -

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

  • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

    • -

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

  • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray.

  • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -926,7 +926,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.total_totals_index.html b/dev/api/generated/metpy.calc.total_totals_index.html index b58bab2a734..da2395473a2 100644 --- a/dev/api/generated/metpy.calc.total_totals_index.html +++ b/dev/api/generated/metpy.calc.total_totals_index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -799,7 +799,7 @@

    total_totals_indexpint.Quantity) – Pressure level(s), in order from highest to lowest pressure

  • temperature (pint.Quantity) – Temperature corresponding to pressure

  • dewpoint (pint.Quantity) – Dewpoint temperature corresponding to pressure

    • -

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

  • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

    • @@ -929,7 +929,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.unit_vectors_from_cross_section.html b/dev/api/generated/metpy.calc.unit_vectors_from_cross_section.html index 2ee404e0d30..afa1e61a594 100644 --- a/dev/api/generated/metpy.calc.unit_vectors_from_cross_section.html +++ b/dev/api/generated/metpy.calc.unit_vectors_from_cross_section.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -793,7 +793,7 @@

    unit_vectors_from_cross_sectionParameters:

    • cross (xarray.DataArray) – The input DataArray of a cross-section from which to obtain latitudes

      • -

    • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as +

    • index (str or int, optional) – Denotes the index coordinate of the cross-section, defaults to ‘index’ as set by metpy.interpolate.cross_section

    @@ -890,7 +890,7 @@

    unit_vectors_from_cross_section

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.vapor_pressure.html b/dev/api/generated/metpy.calc.vapor_pressure.html index 2201221c5af..22c8212b5c6 100644 --- a/dev/api/generated/metpy.calc.vapor_pressure.html +++ b/dev/api/generated/metpy.calc.vapor_pressure.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -908,7 +908,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.calc.vector_derivative.html b/dev/api/generated/metpy.calc.vector_derivative.html index 9cf6c3d2b39..7184fb69067 100644 --- a/dev/api/generated/metpy.calc.vector_derivative.html +++ b/dev/api/generated/metpy.calc.vector_derivative.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,7 +785,7 @@

    vector_derivative

    • u ((…, M, N) xarray.DataArray or pint.Quantity) – x component of the vector

    • v ((…, M, N) xarray.DataArray or pint.Quantity) – y component of the vector

      • -

    • return_only (str or Sequence[str], optional) – Sequence of which components of the derivative matrix to compute and return. If none, +

    • return_only (str or Sequence[str], optional) – Sequence of which components of the derivative matrix to compute and return. If none, returns the full matrix as a tuple of tuples ((‘du/dx’, ‘du/dy’), (‘dv/dx’, ‘dv/dy’)). Otherwise, matches the return pattern of the given strings. Only valid strings are ‘du/dx’, ‘du/dy’, ‘dv/dx’, and ‘dv/dy’.

      • @@ -799,9 +799,9 @@

      vector_derivativeint, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

    • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

      • -

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

    • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -921,7 +921,7 @@

      vector_derivative

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.vertical_totals.html b/dev/api/generated/metpy.calc.vertical_totals.html index 9c6936d5cdb..ef0565fe2bd 100644 --- a/dev/api/generated/metpy.calc.vertical_totals.html +++ b/dev/api/generated/metpy.calc.vertical_totals.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -796,7 +796,7 @@

      vertical_totals

      • pressure (pint.Quantity) – Pressure level(s), in order from highest to lowest pressure

      • temperature (pint.Quantity) – Temperature corresponding to pressure

        • -

      • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from +

      • vertical_dim (int, optional) – The axis corresponding to vertical, defaults to 0. Automatically determined from xarray DataArray arguments.

      @@ -917,7 +917,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.vertical_velocity.html b/dev/api/generated/metpy.calc.vertical_velocity.html index 8afb83fd53d..5161da8a3df 100644 --- a/dev/api/generated/metpy.calc.vertical_velocity.html +++ b/dev/api/generated/metpy.calc.vertical_velocity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -905,7 +905,7 @@

      vertical_velocity

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.vertical_velocity_pressure.html b/dev/api/generated/metpy.calc.vertical_velocity_pressure.html index f2cdb967f23..e05622792b2 100644 --- a/dev/api/generated/metpy.calc.vertical_velocity_pressure.html +++ b/dev/api/generated/metpy.calc.vertical_velocity_pressure.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -903,7 +903,7 @@

      vertical_velocity_pressure

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.virtual_potential_temperature.html b/dev/api/generated/metpy.calc.virtual_potential_temperature.html index 55b71c4578e..e504789f585 100644 --- a/dev/api/generated/metpy.calc.virtual_potential_temperature.html +++ b/dev/api/generated/metpy.calc.virtual_potential_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -899,7 +899,7 @@

      virtual_potential_temperature

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.virtual_temperature.html b/dev/api/generated/metpy.calc.virtual_temperature.html index 9df2b63ef37..c3180c74fbe 100644 --- a/dev/api/generated/metpy.calc.virtual_temperature.html +++ b/dev/api/generated/metpy.calc.virtual_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -898,7 +898,7 @@

      virtual_temperature

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.virtual_temperature_from_dewpoint.html b/dev/api/generated/metpy.calc.virtual_temperature_from_dewpoint.html index b3594611081..1b94f5fc333 100644 --- a/dev/api/generated/metpy.calc.virtual_temperature_from_dewpoint.html +++ b/dev/api/generated/metpy.calc.virtual_temperature_from_dewpoint.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -899,7 +899,7 @@

      virtual_temperature_from_dewpoint

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.vorticity.html b/dev/api/generated/metpy.calc.vorticity.html index d03d6b57710..748f9823a0a 100644 --- a/dev/api/generated/metpy.calc.vorticity.html +++ b/dev/api/generated/metpy.calc.vorticity.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -796,9 +796,9 @@

      vorticityint, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically +

    • x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

      • -

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically +

    • y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using xarray.DataArray. Keyword-only argument.

    • parallel_scale (pint.Quantity, optional) – Parallel scale of map projection at data coordinate. Optional if xarray.DataArray with latitude/longitude coordinates and MetPy CRS used as input. Also optional if @@ -935,7 +935,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.weighted_continuous_average.html b/dev/api/generated/metpy.calc.weighted_continuous_average.html index 0e4d3212d96..b27278ce99a 100644 --- a/dev/api/generated/metpy.calc.weighted_continuous_average.html +++ b/dev/api/generated/metpy.calc.weighted_continuous_average.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -902,7 +902,7 @@

      weighted_continuous_average

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.wet_bulb_potential_temperature.html b/dev/api/generated/metpy.calc.wet_bulb_potential_temperature.html index 23fd088fc6f..34d18840820 100644 --- a/dev/api/generated/metpy.calc.wet_bulb_potential_temperature.html +++ b/dev/api/generated/metpy.calc.wet_bulb_potential_temperature.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -891,7 +891,7 @@

      wet_bulb_potential_temperature

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.wet_bulb_temperature.html b/dev/api/generated/metpy.calc.wet_bulb_temperature.html index 510dcc741f9..bdbcae8a45d 100644 --- a/dev/api/generated/metpy.calc.wet_bulb_temperature.html +++ b/dev/api/generated/metpy.calc.wet_bulb_temperature.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -897,7 +897,7 @@

      wet_bulb_temperature

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.wind_components.html b/dev/api/generated/metpy.calc.wind_components.html index c1b0c3e0709..eda412a64b2 100644 --- a/dev/api/generated/metpy.calc.wind_components.html +++ b/dev/api/generated/metpy.calc.wind_components.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -935,7 +935,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.wind_direction.html b/dev/api/generated/metpy.calc.wind_direction.html index f18e1dfb036..f5801d51a1b 100644 --- a/dev/api/generated/metpy.calc.wind_direction.html +++ b/dev/api/generated/metpy.calc.wind_direction.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,7 +785,7 @@

      wind_direction

      • u (pint.Quantity) – Wind component in the X (East-West) direction

      • v (pint.Quantity) – Wind component in the Y (North-South) direction

        • -

      • convention (str) – Convention to return direction; ‘from’ returns the direction the wind is coming from +

      • convention (str) – Convention to return direction; ‘from’ returns the direction the wind is coming from (meteorological convention), ‘to’ returns the direction the wind is going towards (oceanographic convention), default is ‘from’.

      @@ -897,7 +897,7 @@

      wind_direction

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.wind_speed.html b/dev/api/generated/metpy.calc.wind_speed.html index 628f5cf2954..52361e97d96 100644 --- a/dev/api/generated/metpy.calc.wind_speed.html +++ b/dev/api/generated/metpy.calc.wind_speed.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -906,7 +906,7 @@

      Examples using

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.windchill.html b/dev/api/generated/metpy.calc.windchill.html index e6c02b38df6..6a152393602 100644 --- a/dev/api/generated/metpy.calc.windchill.html +++ b/dev/api/generated/metpy.calc.windchill.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -793,10 +793,10 @@

      windchillpint.Quantity) – Wind speed at 10m. If instead the winds are at face level, face_level_winds should be set to True and the 1.5 multiplicative correction will be applied automatically.

      • -

    • face_level_winds (bool, optional) – A flag indicating whether the wind speeds were measured at facial +

    • face_level_winds (bool, optional) – A flag indicating whether the wind speeds were measured at facial level instead of 10m, thus requiring a correction. Defaults to False.

      • -

    • mask_undefined (bool, optional) – A flag indicating whether a masked array should be returned with +

    • mask_undefined (bool, optional) – A flag indicating whether a masked array should be returned with values where wind chill is undefined masked. These are values where the temperature > 50F or wind speed <= 3 miles per hour. Defaults to True.

      • @@ -898,7 +898,7 @@

      windchill

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.calc.zoom_xarray.html b/dev/api/generated/metpy.calc.zoom_xarray.html index 42518cb1f71..e9cbc2385ea 100644 --- a/dev/api/generated/metpy.calc.zoom_xarray.html +++ b/dev/api/generated/metpy.calc.zoom_xarray.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,14 +786,14 @@

      zoom_xarrayParameters:

      • input_field (xarray.DataArray) – The 2D data array to be interpolated.

        • -

      • zoom (float or Sequence[float]) – The zoom factor along the axes. If a float, zoom is the same for each axis. If a +

      • zoom (float or Sequence[float]) – The zoom factor along the axes. If a float, zoom is the same for each axis. If a sequence, zoom should contain one value for each axis.

        • -

      • order (int, optional) – The order of the spline interpolation, default is 3. The order has to be in the +

      • order (int, optional) – The order of the spline interpolation, default is 3. The order has to be in the range 0-5.

        • -

      • mode (str, optional) – One of {‘reflect’, ‘grid-mirror’, ‘constant’, ‘grid-constant’, ‘nearest’, ‘mirror’, +

      • mode (str, optional) – One of {‘reflect’, ‘grid-mirror’, ‘constant’, ‘grid-constant’, ‘nearest’, ‘mirror’, ‘grid-wrap’, ‘wrap’}. See scipy.ndimage.zoom documentation for details.

        • -

      • cval (float or int, optional) – See scipy.ndimage.zoom documentation for details.

        • -

      • prefilter (bool, optional) – See scipy.ndimage.zoom documentation for details. Defaults to True.

        • +

      • cval (float or int, optional) – See scipy.ndimage.zoom documentation for details.

        • +

      • prefilter (bool, optional) – See scipy.ndimage.zoom documentation for details. Defaults to True.

      Returns:
      @@ -889,7 +889,7 @@

      zoom_xarray

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.constants.html b/dev/api/generated/metpy.constants.html index 4968496d8b7..385b9708ba4 100644 --- a/dev/api/generated/metpy.constants.html +++ b/dev/api/generated/metpy.constants.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -1126,7 +1126,7 @@

      General Meteorology Constants

      - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

      diff --git a/dev/api/generated/metpy.interpolate.cross_section.html b/dev/api/generated/metpy.interpolate.cross_section.html index 001eb30f504..028bb01050c 100644 --- a/dev/api/generated/metpy.interpolate.cross_section.html +++ b/dev/api/generated/metpy.interpolate.cross_section.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -794,9 +794,9 @@

      cross_sectionint, optional) – The number of points along the geodesic between the start and the end point +

    • steps (int, optional) – The number of points along the geodesic between the start and the end point (including the end points) to use in the cross section. Defaults to 100.

      • -

    • interp_type (str, optional) – The interpolation method, either ‘linear’ or ‘nearest’ (see +

    • interp_type (str, optional) – The interpolation method, either ‘linear’ or ‘nearest’ (see xarray.DataArray.interp() for details). Defaults to ‘linear’.

    @@ -903,7 +903,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.geodesic.html b/dev/api/generated/metpy.interpolate.geodesic.html index d3d682de81f..4d750fd13e7 100644 --- a/dev/api/generated/metpy.interpolate.geodesic.html +++ b/dev/api/generated/metpy.interpolate.geodesic.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -789,7 +789,7 @@

    geodesic degrees north and degrees east).

  • end ((2, ) array-like) – A latitude-longitude pair designating the end point of the geodesic (units are degrees north and degrees east).

    • -

  • steps (int, optional) – The number of points along the geodesic between the start and the end point +

  • steps (int, optional) – The number of points along the geodesic between the start and the end point (including the end points).

    • @@ -889,7 +889,7 @@

    geodesic

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.html b/dev/api/generated/metpy.interpolate.html index b6f843f9c28..9f5fd7c5f3d 100644 --- a/dev/api/generated/metpy.interpolate.html +++ b/dev/api/generated/metpy.interpolate.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -893,7 +893,7 @@

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.interpolate_1d.html b/dev/api/generated/metpy.interpolate.interpolate_1d.html index 9de6cc828a7..9f4e44bab22 100644 --- a/dev/api/generated/metpy.interpolate.interpolate_1d.html +++ b/dev/api/generated/metpy.interpolate.interpolate_1d.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -788,10 +788,10 @@

    interpolate_1dint, optional) – The axis to interpolate over. Defaults to 0.

    -

  • fill_value (float, optional) – Specify handling of interpolation points out of data bounds. If None, will return +

  • axis (int, optional) – The axis to interpolate over. Defaults to 0.

    • +

  • fill_value (float, optional) – Specify handling of interpolation points out of data bounds. If None, will return ValueError if points are out of bounds. Defaults to nan.

    • -

  • return_list_always (bool, optional) – Whether to always return a list of interpolated arrays, even when only a single +

  • return_list_always (bool, optional) – Whether to always return a list of interpolated arrays, even when only a single array is passed to args. Defaults to False.

    • @@ -898,7 +898,7 @@

    interpolate_1d

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.interpolate_nans_1d.html b/dev/api/generated/metpy.interpolate.interpolate_nans_1d.html index 40cf77d172e..24208195802 100644 --- a/dev/api/generated/metpy.interpolate.interpolate_nans_1d.html +++ b/dev/api/generated/metpy.interpolate.interpolate_nans_1d.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,7 +786,7 @@

    interpolate_nans_1d @@ -882,7 +882,7 @@

    interpolate_nans_1d

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.interpolate_to_grid.html b/dev/api/generated/metpy.interpolate.interpolate_to_grid.html index 8189a5275ab..1b3c3a57a6f 100644 --- a/dev/api/generated/metpy.interpolate.interpolate_to_grid.html +++ b/dev/api/generated/metpy.interpolate.interpolate_to_grid.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,26 +786,26 @@

    interpolate_to_gridstr) – What type of interpolation to use. Available options include: +

  • interp_type (str) – What type of interpolation to use. Available options include: 1) “linear”, “nearest”, “cubic”, or “rbf” from scipy.interpolate. 2) “natural_neighbor”, “barnes”, or “cressman” from metpy.interpolate. Default “linear”.

    • -

  • hres (float) – The horizontal resolution of the generated grid, given in the same units as the +

  • hres (float) – The horizontal resolution of the generated grid, given in the same units as the x and y parameters. Default 50000.

    • -

  • minimum_neighbors (int) – Minimum number of neighbors needed to perform Barnes or Cressman interpolation for a +

  • minimum_neighbors (int) – Minimum number of neighbors needed to perform Barnes or Cressman interpolation for a point. Default is 3.

    • -

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default 0.25.

    • -

  • kappa_star (float) – Response parameter for barnes interpolation, specified nondimensionally +

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default 0.25.

    • +

  • kappa_star (float) – Response parameter for barnes interpolation, specified nondimensionally in terms of the Nyquist. Default 5.052

    • -

  • search_radius (float) – A search radius to use for the Barnes and Cressman interpolation schemes. +

  • search_radius (float) – A search radius to use for the Barnes and Cressman interpolation schemes. If search_radius is not specified, it will default to 5 times the average spacing of observations.

    • -

  • rbf_func (str) – Specifies which function to use for Rbf interpolation. +

  • rbf_func (str) – Specifies which function to use for Rbf interpolation. Options include: ‘multiquadric’, ‘inverse’, ‘gaussian’, ‘linear’, ‘cubic’, ‘quintic’, and ‘thin_plate’. Default ‘linear’. See scipy.interpolate.Rbf for more information.

    • -

  • rbf_smooth (float) – Smoothing value applied to rbf interpolation. Higher values result in more smoothing.

    • -

  • boundary_coords (dict) – Optional dictionary containing coordinates of the study area boundary. Dictionary +

  • rbf_smooth (float) – Smoothing value applied to rbf interpolation. Higher values result in more smoothing.

    • +

  • boundary_coords (dict) – Optional dictionary containing coordinates of the study area boundary. Dictionary should be in format: {‘west’: west, ‘south’: south, ‘east’: east, ‘north’: north}

    • @@ -925,7 +925,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.interpolate_to_isosurface.html b/dev/api/generated/metpy.interpolate.interpolate_to_isosurface.html index 3bc7639af52..b262648128f 100644 --- a/dev/api/generated/metpy.interpolate.interpolate_to_isosurface.html +++ b/dev/api/generated/metpy.interpolate.interpolate_to_isosurface.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -790,8 +790,8 @@

    interpolate_to_isosurfaceint or float) – Desired interpolated level (e.g., 2 PVU surface)

    -

  • bottom_up_search (bool, optional) – Controls whether to search for levels bottom-up (starting at lower indices), +

  • level (int or float) – Desired interpolated level (e.g., 2 PVU surface)

    • +

  • bottom_up_search (bool, optional) – Controls whether to search for levels bottom-up (starting at lower indices), or top-down (starting at higher indices). Defaults to True, which is bottom-up search.

    • @@ -892,7 +892,7 @@

    interpolate_to_isosurface

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.interpolate_to_points.html b/dev/api/generated/metpy.interpolate.interpolate_to_points.html index 3583a41ea9e..612685dd306 100644 --- a/dev/api/generated/metpy.interpolate.interpolate_to_points.html +++ b/dev/api/generated/metpy.interpolate.interpolate_to_points.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -798,23 +798,23 @@

    interpolate_to_points

    points (array-like, (N, P)) – Coordinates of the data points.

  • values (array-like, (N,)) – Values of the data points.

  • xi (array-like, (M, P)) – Points to interpolate the data onto.

    • -

  • interp_type (str) – What type of interpolation to use. Available options include: +

  • interp_type (str) – What type of interpolation to use. Available options include: 1) “linear”, “nearest”, “cubic”, or “rbf” from scipy.interpolate. 2) “natural_neighbor”, “barnes”, or “cressman” from metpy.interpolate. Default “linear”.

    • -

  • minimum_neighbors (int) – Minimum number of neighbors needed to perform Barnes or Cressman interpolation for a +

  • minimum_neighbors (int) – Minimum number of neighbors needed to perform Barnes or Cressman interpolation for a point. Default is 3.

    • -

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default 0.25.

    • -

  • kappa_star (float) – Response parameter for barnes interpolation, specified non-dimensionally +

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default 0.25.

    • +

  • kappa_star (float) – Response parameter for barnes interpolation, specified non-dimensionally in terms of the Nyquist. Default 5.052.

    • -

  • search_radius (float) – A search radius to use for the Barnes and Cressman interpolation schemes. +

  • search_radius (float) – A search radius to use for the Barnes and Cressman interpolation schemes. If search_radius is not specified, it will default to 5 times the average spacing of observations.

    • -

  • rbf_func (str) – Specifies which function to use for Rbf interpolation. +

  • rbf_func (str) – Specifies which function to use for Rbf interpolation. Options include: ‘multiquadric’, ‘inverse’, ‘gaussian’, ‘linear’, ‘cubic’, ‘quintic’, and ‘thin_plate’. Default ‘linear’. See scipy.interpolate.Rbf for more information.

    • -

  • rbf_smooth (float) – Smoothing value applied to rbf interpolation. Higher values result in more smoothing.

    • +

  • rbf_smooth (float) – Smoothing value applied to rbf interpolation. Higher values result in more smoothing.

    • Returns:
    @@ -916,7 +916,7 @@

    interpolate_to_points

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.interpolate_to_slice.html b/dev/api/generated/metpy.interpolate.interpolate_to_slice.html index 7538e7ef9f6..d572ee16b12 100644 --- a/dev/api/generated/metpy.interpolate.interpolate_to_slice.html +++ b/dev/api/generated/metpy.interpolate.interpolate_to_slice.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -790,7 +790,7 @@

    interpolate_to_slice

  • points ((N, 2) array-like) – A list of x, y points in the data projection at which to interpolate the data

    • -

  • interp_type (str, optional) – The interpolation method, either ‘linear’ or ‘nearest’ (see +

  • interp_type (str, optional) – The interpolation method, either ‘linear’ or ‘nearest’ (see xarray.DataArray.interp() for details). Defaults to ‘linear’.

    • @@ -890,7 +890,7 @@

    interpolate_to_slice

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.inverse_distance_to_grid.html b/dev/api/generated/metpy.interpolate.inverse_distance_to_grid.html index 62ee6451beb..fff4a59b444 100644 --- a/dev/api/generated/metpy.interpolate.inverse_distance_to_grid.html +++ b/dev/api/generated/metpy.interpolate.inverse_distance_to_grid.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -791,13 +791,13 @@

    inverse_distance_to_gridnumpy.ndarray) – Meshgrid associated with x dimension.

  • grid_y ((M, 2) numpy.ndarray) – Meshgrid associated with y dimension.

    • -

  • r (float) – Radius from grid center, within which observations +

  • r (float) – Radius from grid center, within which observations are considered and weighted.

    • -

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default None.

    • -

  • kappa (float) – Response parameter for barnes interpolation. Default None.

    • -

  • min_neighbors (int) – Minimum number of neighbors needed to perform barnes or cressman interpolation +

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default None.

    • +

  • kappa (float) – Response parameter for barnes interpolation. Default None.

    • +

  • min_neighbors (int) – Minimum number of neighbors needed to perform barnes or cressman interpolation for a point. Default is 3.

    • -

  • kind (str) – Specify what inverse distance weighting interpolation to use. +

  • kind (str) – Specify what inverse distance weighting interpolation to use. Options: ‘cressman’ or ‘barnes’. Default ‘cressman’

    • @@ -897,7 +897,7 @@

    inverse_distance_to_grid

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.inverse_distance_to_points.html b/dev/api/generated/metpy.interpolate.inverse_distance_to_points.html index 277ac96984a..4406b378b92 100644 --- a/dev/api/generated/metpy.interpolate.inverse_distance_to_points.html +++ b/dev/api/generated/metpy.interpolate.inverse_distance_to_points.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -788,12 +788,12 @@

    inverse_distance_to_pointsfloat) – Radius from grid center, within which observations are considered and weighted.

    -

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default None.

    • -

  • kappa (float) – Response parameter for barnes interpolation. Default None.

    • -

  • min_neighbors (int) – Minimum number of neighbors needed to perform barnes or cressman interpolation +

  • r (float) – Radius from grid center, within which observations are considered and weighted.

    • +

  • gamma (float) – Adjustable smoothing parameter for the barnes interpolation. Default None.

    • +

  • kappa (float) – Response parameter for barnes interpolation. Default None.

    • +

  • min_neighbors (int) – Minimum number of neighbors needed to perform barnes or cressman interpolation for a point. Default is 3.

    • -

  • kind (str) – Specify what inverse distance weighting interpolation to use. +

  • kind (str) – Specify what inverse distance weighting interpolation to use. Options: ‘cressman’ or ‘barnes’. Default ‘cressman’

    • @@ -893,7 +893,7 @@

    inverse_distance_to_points

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.log_interpolate_1d.html b/dev/api/generated/metpy.interpolate.log_interpolate_1d.html index 5d75aeea96d..6944ec3aaf7 100644 --- a/dev/api/generated/metpy.interpolate.log_interpolate_1d.html +++ b/dev/api/generated/metpy.interpolate.log_interpolate_1d.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -788,8 +788,8 @@

    log_interpolate_1dint, optional) – The axis to interpolate over. Defaults to 0.

    -

  • fill_value (float, optional) – Specify handling of interpolation points out of data bounds. If None, will return +

  • axis (int, optional) – The axis to interpolate over. Defaults to 0.

    • +

  • fill_value (float, optional) – Specify handling of interpolation points out of data bounds. If None, will return ValueError if points are out of bounds. Defaults to nan.

    • @@ -902,7 +902,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.natural_neighbor_to_grid.html b/dev/api/generated/metpy.interpolate.natural_neighbor_to_grid.html index 4a987f878ff..12de30d77bc 100644 --- a/dev/api/generated/metpy.interpolate.natural_neighbor_to_grid.html +++ b/dev/api/generated/metpy.interpolate.natural_neighbor_to_grid.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -889,7 +889,7 @@

    natural_neighbor_to_grid

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.natural_neighbor_to_points.html b/dev/api/generated/metpy.interpolate.natural_neighbor_to_points.html index 4eb507ad6f8..e210f75253d 100644 --- a/dev/api/generated/metpy.interpolate.natural_neighbor_to_points.html +++ b/dev/api/generated/metpy.interpolate.natural_neighbor_to_points.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -886,7 +886,7 @@

    natural_neighbor_to_points

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.remove_nan_observations.html b/dev/api/generated/metpy.interpolate.remove_nan_observations.html index 2257f89235c..a840f2519d0 100644 --- a/dev/api/generated/metpy.interpolate.remove_nan_observations.html +++ b/dev/api/generated/metpy.interpolate.remove_nan_observations.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -892,7 +892,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.remove_observations_below_value.html b/dev/api/generated/metpy.interpolate.remove_observations_below_value.html index d7a83e80463..528481e1592 100644 --- a/dev/api/generated/metpy.interpolate.remove_observations_below_value.html +++ b/dev/api/generated/metpy.interpolate.remove_observations_below_value.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -787,7 +787,7 @@

    remove_observations_below_valuefloat) – Value at which to threshold z.

    +

  • val (float) – Value at which to threshold z.

    • Returns:
    @@ -883,7 +883,7 @@

    remove_observations_below_value

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.interpolate.remove_repeat_coordinates.html b/dev/api/generated/metpy.interpolate.remove_repeat_coordinates.html index a793bbc55b7..744cf0441fb 100644 --- a/dev/api/generated/metpy.interpolate.remove_repeat_coordinates.html +++ b/dev/api/generated/metpy.interpolate.remove_repeat_coordinates.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -889,7 +889,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.GempakGrid.html b/dev/api/generated/metpy.io.GempakGrid.html index 8e9fbf025fa..ee15f8909eb 100644 --- a/dev/api/generated/metpy.io.GempakGrid.html +++ b/dev/api/generated/metpy.io.GempakGrid.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -865,14 +865,14 @@

    GempakGrid
    Parameters:
      -

    • parameter (str or Sequence[str]) – Name of GEMPAK parameter.

      • -

    • date_time (datetime or Sequence[datetime]) – Valid datetime of the grid. Alternatively can be +

    • parameter (str or Sequence[str]) – Name of GEMPAK parameter.

      • +

    • date_time (datetime or Sequence[datetime]) – Valid datetime of the grid. Alternatively can be a string with the format YYYYmmddHHMM.

      • -

    • coordinate (str or Sequence[str]) – Vertical coordinate.

      • -

    • level (float or Sequence[float]) – Vertical level.

      • -

    • date_time2 (datetime or Sequence[datetime]) – Secondary valid datetime of the grid. Alternatively can be +

    • coordinate (str or Sequence[str]) – Vertical coordinate.

      • +

    • level (float or Sequence[float]) – Vertical level.

      • +

    • date_time2 (datetime or Sequence[datetime]) – Secondary valid datetime of the grid. Alternatively can be a string with the format YYYYmmddHHMM.

      • -

    • level2 (float or Sequence[float]) – Secondary vertical level. Typically used for layers.

      • +

    • level2 (float or Sequence[float]) – Secondary vertical level. Typically used for layers.

    Returns:
    @@ -979,7 +979,7 @@

    GempakGrid

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.GempakSounding.html b/dev/api/generated/metpy.io.GempakSounding.html index 79bd1d39d0e..f7c5f4a47b1 100644 --- a/dev/api/generated/metpy.io.GempakSounding.html +++ b/dev/api/generated/metpy.io.GempakSounding.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -865,12 +865,12 @@

    GempakSounding
    Parameters:
      -

    • station_id (str or Sequence[str]) – Station ID of sounding site.

      • -

    • station_number (int or Sequence[int]) – Station number of sounding site.

      • -

    • date_time (datetime or Sequence[datetime]) – Valid datetime of the grid. Alternatively can be +

    • station_id (str or Sequence[str]) – Station ID of sounding site.

      • +

    • station_number (int or Sequence[int]) – Station number of sounding site.

      • +

    • date_time (datetime or Sequence[datetime]) – Valid datetime of the grid. Alternatively can be a string with the format YYYYmmddHHMM.

      • -

    • state (str or Sequence[str]) – State where sounding site is located.

      • -

    • country (str or Sequence[str]) – Country where sounding site is located.

      • +

    • state (str or Sequence[str]) – State where sounding site is located.

      • +

    • country (str or Sequence[str]) – Country where sounding site is located.

    Returns:
    @@ -977,7 +977,7 @@

    GempakSounding

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.GempakSurface.html b/dev/api/generated/metpy.io.GempakSurface.html index a9a6ebd99c3..343c7fde47d 100644 --- a/dev/api/generated/metpy.io.GempakSurface.html +++ b/dev/api/generated/metpy.io.GempakSurface.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -860,11 +860,11 @@

    GempakSurface
    Parameters:
      -

    • date_time (datetime or Sequence[datetime]) – Valid/observed datetime of the surface station. Alternatively +

    • date_time (datetime or Sequence[datetime]) – Valid/observed datetime of the surface station. Alternatively object or a string with the format YYYYmmddHHMM.

      • -

    • station_id (str or Sequence[str]) – Station ID of the surface station(s).

      • -

    • station_number (int or Sequence[int]) – Station number of the surface station.

      • -

    • include_special (bool) – If True, parse special observations that are stored +

    • station_id (str or Sequence[str]) – Station ID of the surface station(s).

      • +

    • station_number (int or Sequence[int]) – Station number of the surface station.

      • +

    • include_special (bool) – If True, parse special observations that are stored as raw METAR text. Default is False.

    @@ -892,13 +892,13 @@

    GempakSurface
    Parameters:
      -

    • station_id (str or Sequence[str]) – Station ID of the surface station.

      • -

    • station_number (int or Sequence[int]) – Station number of the surface station.

      • -

    • date_time (datetime or Sequence[datetime]) – Valid datetime of the grid. Alternatively can be +

    • station_id (str or Sequence[str]) – Station ID of the surface station.

      • +

    • station_number (int or Sequence[int]) – Station number of the surface station.

      • +

    • date_time (datetime or Sequence[datetime]) – Valid datetime of the grid. Alternatively can be a string with the format YYYYmmddHHMM.

      • -

    • state (str or Sequence[str]) – State where surface station is located.

      • -

    • country (str or Sequence[str]) – Country where surface station is located.

      • -

    • include_special (bool) – If True, parse special observations that are stored +

    • state (str or Sequence[str]) – State where surface station is located.

      • +

    • country (str or Sequence[str]) – Country where surface station is located.

      • +

    • include_special (bool) – If True, parse special observations that are stored as raw METAR text. Default is False.

    @@ -1007,7 +1007,7 @@

    GempakSurface

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.GiniFile.html b/dev/api/generated/metpy.io.GiniFile.html index faaa1e8417d..c245b51fb56 100644 --- a/dev/api/generated/metpy.io.GiniFile.html +++ b/dev/api/generated/metpy.io.GiniFile.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,7 +786,7 @@

    GiniFile

    Create an instance of GiniFile.

    Parameters:
    -

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are +

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are recognized with the extension '.gz', as are bzip2-ed files with the extension '.bz2' If filename is a file-like object, this will be read from directly.

    @@ -913,7 +913,7 @@

    GiniFile

    Create an instance of GiniFile.

    Parameters:
    -

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are +

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are recognized with the extension '.gz', as are bzip2-ed files with the extension '.bz2' If filename is a file-like object, this will be read from directly.

    @@ -1086,7 +1086,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.Level2File.html b/dev/api/generated/metpy.io.Level2File.html index c64b88781bf..2de3be12375 100644 --- a/dev/api/generated/metpy.io.Level2File.html +++ b/dev/api/generated/metpy.io.Level2File.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -789,7 +789,7 @@

    Level2File
    Type:
    -

    str

    +

    str

    @@ -800,7 +800,7 @@

    Level2File
    Type:
    -

    datetime

    +

    datetime

    @@ -811,7 +811,7 @@

    Level2File
    Type:
    -

    collections.namedtuple

    +

    collections.namedtuple

    @@ -822,7 +822,7 @@

    Level2File
    Type:
    -

    list[tuple]

    +

    list[tuple]

    @@ -833,7 +833,7 @@

    Level2File
    Type:
    -

    collections.namedtuple, optional

    +

    collections.namedtuple, optional

    @@ -844,7 +844,7 @@

    Level2File
    Type:
    -

    collections.namedtuple, optional

    +

    collections.namedtuple, optional

    @@ -855,7 +855,7 @@

    Level2File
    Type:
    -

    dict, optional

    +

    dict, optional

    @@ -866,7 +866,7 @@

    Level2File
    Type:
    -

    collections.namedtuple, optional

    +

    collections.namedtuple, optional

    @@ -877,7 +877,7 @@

    Level2File
    Type:
    -

    dict, optional

    +

    dict, optional

    @@ -888,7 +888,7 @@

    Level2File
    Type:
    -

    dict, optional

    +

    dict, optional

    @@ -899,7 +899,7 @@

    Level2File
    Type:
    -

    dict, optional

    +

    dict, optional

    @@ -910,9 +910,9 @@

    Level2FileLevel2File.

    Parameters:
    -

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are +

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are recognized with the extension ‘.gz’, as are bzip2-ed files with -the extension bz2 If filename is a file-like object, +the extension bz2 If filename is a file-like object, this will be read from directly.

    @@ -1083,9 +1083,9 @@

    Level2FileLevel2File.

    Parameters:
    -

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are +

    filename (str or file-like object) – If str, the name of the file to be opened. Gzip-ed files are recognized with the extension ‘.gz’, as are bzip2-ed files with -the extension bz2 If filename is a file-like object, +the extension bz2 If filename is a file-like object, this will be read from directly.

    @@ -1218,7 +1218,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.Level3File.html b/dev/api/generated/metpy.io.Level3File.html index d9199336e17..189446cfe75 100644 --- a/dev/api/generated/metpy.io.Level3File.html +++ b/dev/api/generated/metpy.io.Level3File.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -789,7 +789,7 @@

    Level3File
    Type:
    -

    dict

    +

    dict

    @@ -800,7 +800,7 @@

    Level3File
    Type:
    -

    collections.namedtuple

    +

    collections.namedtuple

    @@ -811,7 +811,7 @@

    Level3File
    Type:
    -

    collections.namedtuple

    +

    collections.namedtuple

    @@ -822,7 +822,7 @@

    Level3File
    Type:
    -

    str

    +

    str

    @@ -833,7 +833,7 @@

    Level3File
    Type:
    -

    float

    +

    float

    @@ -844,7 +844,7 @@

    Level3File
    Type:
    -

    float

    +

    float

    @@ -855,7 +855,7 @@

    Level3File
    Type:
    -

    float

    +

    float

    @@ -866,7 +866,7 @@

    Level3File
    Type:
    -

    str

    +

    str

    @@ -877,7 +877,7 @@

    Level3File
    Type:
    -

    float

    +

    float

    @@ -899,7 +899,7 @@

    Level3File
    Type:
    -

    list, optional

    +

    list, optional

    @@ -910,7 +910,7 @@

    Level3File
    Type:
    -

    list, optional

    +

    list, optional

    @@ -921,7 +921,7 @@

    Level3File
    Type:
    -

    list, optional

    +

    list, optional

    @@ -932,7 +932,7 @@

    Level3FileLevel3File.

    Parameters:
    -

    filename (str or file-like object) – If str, the name of the file to be opened. If file-like object, +

    filename (str or file-like object) – If str, the name of the file to be opened. If file-like object, this will be read from directly.

    @@ -1090,7 +1090,7 @@

    Level3FileLevel3File.

    Parameters:
    -

    filename (str or file-like object) – If str, the name of the file to be opened. If file-like object, +

    filename (str or file-like object) – If str, the name of the file to be opened. If file-like object, this will be read from directly.

    @@ -1230,7 +1230,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.StationLookup.html b/dev/api/generated/metpy.io.StationLookup.html index 276f9b6425b..e48756ff2b9 100644 --- a/dev/api/generated/metpy.io.StationLookup.html +++ b/dev/api/generated/metpy.io.StationLookup.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -947,7 +947,7 @@

    StationLookup

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.add_station_lat_lon.html b/dev/api/generated/metpy.io.add_station_lat_lon.html index 98390b37b1b..d5782c3b7d0 100644 --- a/dev/api/generated/metpy.io.add_station_lat_lon.html +++ b/dev/api/generated/metpy.io.add_station_lat_lon.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,7 +786,7 @@

    add_station_lat_lonParameters:

    • df (pandas.DataFrame) – The DataFrame that contains the station observations

      • -

    • stn_var (str, optional) – The string of the variable name that represents the station in the DataFrame. If not +

    • stn_var (str, optional) – The string of the variable name that represents the station in the DataFrame. If not provided, ‘station’, ‘stid’, and ‘station_id’ are tried in that order.

    @@ -886,7 +886,7 @@

    add_station_lat_lon

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.html b/dev/api/generated/metpy.io.html index 609501e225c..2064612ffb3 100644 --- a/dev/api/generated/metpy.io.html +++ b/dev/api/generated/metpy.io.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -772,8 +772,8 @@

    Tools for reading various file formats.

    Classes supporting formats are written to take both file names (for local files) or file-like objects; this allows reading files that are already in memory -(using io.StringIO) or remote files -(using urlopen()).

    +(using io.StringIO) or remote files +(using urlopen()).

    station_info is an instance of StationLookup to find information about station locations (e.g. latitude, longitude, altitude) from various sources.

    Functions

    @@ -893,7 +893,7 @@

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.is_precip_mode.html b/dev/api/generated/metpy.io.is_precip_mode.html index e8fc7341116..82ae50c09c8 100644 --- a/dev/api/generated/metpy.io.is_precip_mode.html +++ b/dev/api/generated/metpy.io.is_precip_mode.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -782,7 +782,7 @@

    is_precip_mode
    Parameters:
    -

    vcp_num (int) – The NEXRAD volume coverage pattern (VCP) number

    +

    vcp_num (int) – The NEXRAD volume coverage pattern (VCP) number

    Returns:

    bool – True if the VCP corresponds to precipitation mode, False otherwise

    @@ -876,7 +876,7 @@

    is_precip_mode

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.parse_metar_file.html b/dev/api/generated/metpy.io.parse_metar_file.html index 3f184bbc957..58466ea902e 100644 --- a/dev/api/generated/metpy.io.parse_metar_file.html +++ b/dev/api/generated/metpy.io.parse_metar_file.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -783,11 +783,11 @@

    parse_metar_file
    Parameters:
      -

    • filename (str or file-like object) – If str, the name of the file to be opened. If filename is a file-like object, +

    • filename (str or file-like object) – If str, the name of the file to be opened. If filename is a file-like object, this will be read from directly and needs to be opened in text mode (i.e. read() needs to return a string, not bytes).

      • -

    • year (int, optional) – Year in which observation was taken, defaults to current year. Keyword-only argument.

      • -

    • month (int, optional) – Month in which observation was taken, defaults to current month. Keyword-only argument.

      • +

    • year (int, optional) – Year in which observation was taken, defaults to current year. Keyword-only argument.

      • +

    • month (int, optional) – Month in which observation was taken, defaults to current month. Keyword-only argument.

    Returns:
    @@ -934,7 +934,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.parse_metar_to_dataframe.html b/dev/api/generated/metpy.io.parse_metar_to_dataframe.html index 3c01c6a57e1..271308ed604 100644 --- a/dev/api/generated/metpy.io.parse_metar_to_dataframe.html +++ b/dev/api/generated/metpy.io.parse_metar_to_dataframe.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -788,9 +788,9 @@

    parse_metar_to_dataframe
    Parameters:
      -

    • metar_text (str) – The METAR report

      • -

    • year (int, optional) – Year in which observation was taken, defaults to current year. Keyword-only argument.

      • -

    • month (int, optional) – Month in which observation was taken, defaults to current month. Keyword-only argument.

      • +

    • metar_text (str) – The METAR report

      • +

    • year (int, optional) – Year in which observation was taken, defaults to current year. Keyword-only argument.

      • +

    • month (int, optional) – Month in which observation was taken, defaults to current month. Keyword-only argument.

    Returns:
    @@ -924,7 +924,7 @@

    parse_metar_to_dataframe

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.io.parse_wpc_surface_bulletin.html b/dev/api/generated/metpy.io.parse_wpc_surface_bulletin.html index 44c7db6941d..f4c4813cee3 100644 --- a/dev/api/generated/metpy.io.parse_wpc_surface_bulletin.html +++ b/dev/api/generated/metpy.io.parse_wpc_surface_bulletin.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -782,7 +782,7 @@

    parse_wpc_surface_bulletin
    Parameters:
    -

    bulletin (str or file-like object) – If str, the name of the file to be opened. If bulletin is a file-like object, +

    bulletin (str or file-like object) – If str, the name of the file to be opened. If bulletin is a file-like object, this will be read from directly.

    Returns:
    @@ -891,7 +891,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ArrowPlot.html b/dev/api/generated/metpy.plots.ArrowPlot.html index b5cfca20d00..e4676032b7a 100644 --- a/dev/api/generated/metpy.plots.ArrowPlot.html +++ b/dev/api/generated/metpy.plots.ArrowPlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    ArrowPlot#

    -class metpy.plots.ArrowPlot(**kwargs: Any)[source]#
    +class metpy.plots.ArrowPlot(**kwargs: Any)[source]#

    Make plots of wind barbs on a map with traits to refine the look of plotted elements.

    Attributes Summary

    @@ -1126,7 +1126,7 @@

    ArrowPlottime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1152,32 +1152,32 @@

    ArrowPlotMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1185,7 +1185,7 @@

    ArrowPlot
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1232,13 +1232,13 @@

    ArrowPlot
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1248,13 +1248,13 @@

    ArrowPlot
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1270,10 +1270,10 @@

    ArrowPlotold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1282,7 +1282,7 @@

    ArrowPlot
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1298,10 +1298,10 @@

    ArrowPlotlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1310,19 +1310,19 @@

    ArrowPlot
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1331,11 +1331,11 @@

    ArrowPlot
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1346,7 +1346,7 @@

    ArrowPlot
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1367,19 +1367,19 @@

    ArrowPlot
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1400,7 +1400,7 @@

    ArrowPlot
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1415,17 +1415,17 @@

    ArrowPlot
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1434,7 +1434,7 @@

    ArrowPlot
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1578,7 +1578,7 @@

    ArrowPlot

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.BarbPlot.html b/dev/api/generated/metpy.plots.BarbPlot.html index 3828ba24e45..8c83440eaf7 100644 --- a/dev/api/generated/metpy.plots.BarbPlot.html +++ b/dev/api/generated/metpy.plots.BarbPlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    BarbPlot#

    -class metpy.plots.BarbPlot(**kwargs: Any)[source]#
    +class metpy.plots.BarbPlot(**kwargs: Any)[source]#

    Make plots of wind barbs on a map with traits to refine the look of plotted elements.

    Attributes Summary

    @@ -1102,7 +1102,7 @@

    BarbPlot time#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1128,32 +1128,32 @@

    BarbPlot

    Methods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1161,7 +1161,7 @@

    BarbPlot
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1208,13 +1208,13 @@

    BarbPlot
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1224,13 +1224,13 @@

    BarbPlot
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1246,10 +1246,10 @@

    BarbPlot * old : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1258,7 +1258,7 @@

    BarbPlot
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1274,10 +1274,10 @@

    BarbPlot

  • handler (callable, None) – A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new), handler(name, old, new), or handler(name, old, new, self).

    • -

  • name (list, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1286,19 +1286,19 @@

    BarbPlot
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1307,11 +1307,11 @@

    BarbPlot
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1322,7 +1322,7 @@

    BarbPlot
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1343,19 +1343,19 @@

    BarbPlot
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1376,7 +1376,7 @@

    BarbPlot
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1391,17 +1391,17 @@

    BarbPlot
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1410,7 +1410,7 @@

    BarbPlot
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1560,7 +1560,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ColdFront.html b/dev/api/generated/metpy.plots.ColdFront.html index 1c4214fa821..8881d4f7e7d 100644 --- a/dev/api/generated/metpy.plots.ColdFront.html +++ b/dev/api/generated/metpy.plots.ColdFront.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,12 +784,12 @@

    ColdFront
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

      • -

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

      • +

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

    @@ -829,12 +829,12 @@

    ColdFront
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

      • -

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

      • +

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

    @@ -949,7 +949,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ColdFrontogenesis.html b/dev/api/generated/metpy.plots.ColdFrontogenesis.html index fdc980796d4..4f9a1b2a1db 100644 --- a/dev/api/generated/metpy.plots.ColdFrontogenesis.html +++ b/dev/api/generated/metpy.plots.ColdFrontogenesis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,10 +784,10 @@

    ColdFrontogenesis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -828,10 +828,10 @@

    ColdFrontogenesis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -937,7 +937,7 @@

    ColdFrontogenesis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ColdFrontolysis.html b/dev/api/generated/metpy.plots.ColdFrontolysis.html index 1774d38f10c..eb16e275816 100644 --- a/dev/api/generated/metpy.plots.ColdFrontolysis.html +++ b/dev/api/generated/metpy.plots.ColdFrontolysis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,10 +784,10 @@

    ColdFrontolysis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -828,10 +828,10 @@

    ColdFrontolysis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -937,7 +937,7 @@

    ColdFrontolysis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ContourPlot.html b/dev/api/generated/metpy.plots.ContourPlot.html index ed1dc3ca788..b19c3280e71 100644 --- a/dev/api/generated/metpy.plots.ContourPlot.html +++ b/dev/api/generated/metpy.plots.ContourPlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    ContourPlot#

    -class metpy.plots.ContourPlot(**kwargs: Any)[source]#
    +class metpy.plots.ContourPlot(**kwargs: Any)[source]#

    Make contour plots by defining specific traits.

    Attributes Summary

    @@ -1152,7 +1152,7 @@

    ContourPlottime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1178,32 +1178,32 @@

    ContourPlotMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1211,7 +1211,7 @@

    ContourPlot
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1258,13 +1258,13 @@

    ContourPlot
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1274,13 +1274,13 @@

    ContourPlot
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1296,10 +1296,10 @@

    ContourPlotold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1308,7 +1308,7 @@

    ContourPlot
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1324,10 +1324,10 @@

    ContourPlotlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1336,19 +1336,19 @@

    ContourPlot
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1357,11 +1357,11 @@

    ContourPlot
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1372,7 +1372,7 @@

    ContourPlot
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1393,19 +1393,19 @@

    ContourPlot
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1426,7 +1426,7 @@

    ContourPlot
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1441,17 +1441,17 @@

    ContourPlot
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1460,7 +1460,7 @@

    ContourPlot
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1616,7 +1616,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.Dryline.html b/dev/api/generated/metpy.plots.Dryline.html index db43a3d864f..666911c68c6 100644 --- a/dev/api/generated/metpy.plots.Dryline.html +++ b/dev/api/generated/metpy.plots.Dryline.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,12 +784,12 @@

    Dryline#<
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

      • -

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

      • +

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

    @@ -829,12 +829,12 @@

    Dryline#<
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

      • -

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

      • +

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

    @@ -939,7 +939,7 @@

    Dryline#<

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.FilledContourPlot.html b/dev/api/generated/metpy.plots.FilledContourPlot.html index c547bd67076..a59f4231f7c 100644 --- a/dev/api/generated/metpy.plots.FilledContourPlot.html +++ b/dev/api/generated/metpy.plots.FilledContourPlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    FilledContourPlot#

    -class metpy.plots.FilledContourPlot(**kwargs: Any)[source]#
    +class metpy.plots.FilledContourPlot(**kwargs: Any)[source]#

    Make color-filled contours plots by defining appropriate traits.

    Attributes Summary

    @@ -1164,7 +1164,7 @@

    FilledContourPlottime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1190,32 +1190,32 @@

    FilledContourPlotMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1223,7 +1223,7 @@

    FilledContourPlot
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1270,13 +1270,13 @@

    FilledContourPlot
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1286,13 +1286,13 @@

    FilledContourPlot
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1308,10 +1308,10 @@

    FilledContourPlotold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1320,7 +1320,7 @@

    FilledContourPlot
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1336,10 +1336,10 @@

    FilledContourPlotlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1348,19 +1348,19 @@

    FilledContourPlot
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1369,11 +1369,11 @@

    FilledContourPlot
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1384,7 +1384,7 @@

    FilledContourPlot
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1405,19 +1405,19 @@

    FilledContourPlot
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1438,7 +1438,7 @@

    FilledContourPlot
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1453,17 +1453,17 @@

    FilledContourPlot
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1472,7 +1472,7 @@

    FilledContourPlot
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1626,7 +1626,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.Hodograph.html b/dev/api/generated/metpy.plots.Hodograph.html index 2c852f90853..615e168d24b 100644 --- a/dev/api/generated/metpy.plots.Hodograph.html +++ b/dev/api/generated/metpy.plots.Hodograph.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -800,7 +800,7 @@

    HodographParameters:

    • ax (matplotlib.axes.Axes, optional) – The Axes instance used for plotting

      • -

    • component_range (int) – The maximum range of the plot. Used to set plot bounds and control the maximum +

    • component_range (int) – The maximum range of the plot. Used to set plot bounds and control the maximum number of grid rings needed.

    @@ -835,7 +835,7 @@

    HodographParameters:

    • ax (matplotlib.axes.Axes, optional) – The Axes instance used for plotting

      • -

    • component_range (int) – The maximum range of the plot. Used to set plot bounds and control the maximum +

    • component_range (int) – The maximum range of the plot. Used to set plot bounds and control the maximum number of grid rings needed.

    @@ -850,7 +850,7 @@

    Hodograph
    Parameters:
      -

    • increment (int, optional) – The value increment between rings

      • +

    • increment (int, optional) – The value increment between rings

    • kwargs – Other kwargs to control appearance of lines

    @@ -904,7 +904,7 @@

    Hodographlist, optional) – Array of strings representing colors for the hodograph segments.

    +

  • colors (list, optional) – Array of strings representing colors for the hodograph segments.

  • kwargs – Other keyword arguments to pass to matplotlib.collections.LineCollection

    • @@ -1049,7 +1049,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ImagePlot.html b/dev/api/generated/metpy.plots.ImagePlot.html index ce765f1b178..f0d66a8bdd4 100644 --- a/dev/api/generated/metpy.plots.ImagePlot.html +++ b/dev/api/generated/metpy.plots.ImagePlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    ImagePlot#

    -class metpy.plots.ImagePlot(**kwargs: Any)[source]#
    +class metpy.plots.ImagePlot(**kwargs: Any)[source]#

    Make raster image using imshow for satellite or colored image.

    Attributes Summary

    @@ -1127,7 +1127,7 @@

    ImagePlottime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1153,32 +1153,32 @@

    ImagePlotMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1186,7 +1186,7 @@

    ImagePlot
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1233,13 +1233,13 @@

    ImagePlot
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1249,13 +1249,13 @@

    ImagePlot
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1271,10 +1271,10 @@

    ImagePlotold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1283,7 +1283,7 @@

    ImagePlot
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1299,10 +1299,10 @@

    ImagePlotlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1311,19 +1311,19 @@

    ImagePlot
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1332,11 +1332,11 @@

    ImagePlot
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1347,7 +1347,7 @@

    ImagePlot
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1368,19 +1368,19 @@

    ImagePlot
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1401,7 +1401,7 @@

    ImagePlot
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1416,17 +1416,17 @@

    ImagePlot
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1435,7 +1435,7 @@

    ImagePlot
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1589,7 +1589,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.MapPanel.html b/dev/api/generated/metpy.plots.MapPanel.html index 564ed55ea2c..2470b68849b 100644 --- a/dev/api/generated/metpy.plots.MapPanel.html +++ b/dev/api/generated/metpy.plots.MapPanel.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    MapPanel#

    -class metpy.plots.MapPanel(**kwargs: Any)[source]#
    +class metpy.plots.MapPanel(**kwargs: Any)[source]#

    Set figure related elements for an individual panel.

    Parameters that need to be set include collecting all plotting types (e.g., contours, wind barbs, etc.) that are desired to be in a given panel. @@ -1108,32 +1108,32 @@

    MapPanel

    Methods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1141,7 +1141,7 @@

    MapPanel
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1169,13 +1169,13 @@

    MapPanel
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1185,13 +1185,13 @@

    MapPanel
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1207,10 +1207,10 @@

    MapPanel * old : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1219,7 +1219,7 @@

    MapPanel
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1235,10 +1235,10 @@

    MapPanel

  • handler (callable, None) – A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new), handler(name, old, new), or handler(name, old, new, self).

    • -

  • name (list, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1253,19 +1253,19 @@

    MapPanel
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1274,11 +1274,11 @@

    MapPanel
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1289,7 +1289,7 @@

    MapPanel
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1310,19 +1310,19 @@

    MapPanel
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1343,7 +1343,7 @@

    MapPanel
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1358,17 +1358,17 @@

    MapPanel
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1377,7 +1377,7 @@

    MapPanel
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1546,7 +1546,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.OccludedFront.html b/dev/api/generated/metpy.plots.OccludedFront.html index 6c92609790a..ca4b0f0b91b 100644 --- a/dev/api/generated/metpy.plots.OccludedFront.html +++ b/dev/api/generated/metpy.plots.OccludedFront.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,12 +784,12 @@

    OccludedFront
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

      • -

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

      • +

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

    @@ -829,12 +829,12 @@

    OccludedFront
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

      • -

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

      • +

    • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

    @@ -946,7 +946,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.OccludedFrontogenesis.html b/dev/api/generated/metpy.plots.OccludedFrontogenesis.html index f4d5b00c219..588ea871f63 100644 --- a/dev/api/generated/metpy.plots.OccludedFrontogenesis.html +++ b/dev/api/generated/metpy.plots.OccludedFrontogenesis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,10 +784,10 @@

    OccludedFrontogenesis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -828,10 +828,10 @@

    OccludedFrontogenesis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -937,7 +937,7 @@

    OccludedFrontogenesis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.OccludedFrontolysis.html b/dev/api/generated/metpy.plots.OccludedFrontolysis.html index 58e2d8af370..af83e3b5cfb 100644 --- a/dev/api/generated/metpy.plots.OccludedFrontolysis.html +++ b/dev/api/generated/metpy.plots.OccludedFrontolysis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,10 +784,10 @@

    OccludedFrontolysis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -828,10 +828,10 @@

    OccludedFrontolysis
    Parameters:
      -

    • color (str or tuple[float]) – Color to use for the effect.

      • -

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • -

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • -

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

    • color (str or tuple[float]) – Color to use for the effect.

      • +

    • size (int or float) – The size of the markers to plot in points. Defaults to 10.

      • +

    • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

      • +

    • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

    @@ -937,7 +937,7 @@

    OccludedFrontolysis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.PanelContainer.html b/dev/api/generated/metpy.plots.PanelContainer.html index 31c76f65bd6..d6c5a847ac9 100644 --- a/dev/api/generated/metpy.plots.PanelContainer.html +++ b/dev/api/generated/metpy.plots.PanelContainer.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    PanelContainer#

    -class metpy.plots.PanelContainer(**kwargs: Any)[source]#
    +class metpy.plots.PanelContainer(**kwargs: Any)[source]#

    Collects panels and set complete figure related settings (e.g., size).

    Attributes Summary

    @@ -945,32 +945,32 @@

    PanelContainerMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -978,7 +978,7 @@

    PanelContainer
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1006,13 +1006,13 @@

    PanelContainer
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1022,13 +1022,13 @@

    PanelContainer
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1044,10 +1044,10 @@

    PanelContainerold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1056,7 +1056,7 @@

    PanelContainer
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1072,10 +1072,10 @@

    PanelContainerlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1098,13 +1098,13 @@

    PanelContainer
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    @@ -1116,7 +1116,7 @@

    PanelContainer
    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1125,11 +1125,11 @@

    PanelContainer
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1140,7 +1140,7 @@

    PanelContainer
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1161,19 +1161,19 @@

    PanelContainer
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1194,7 +1194,7 @@

    PanelContainer
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1209,17 +1209,17 @@

    PanelContainer
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1228,7 +1228,7 @@

    PanelContainer
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1387,7 +1387,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.PlotGeometry.html b/dev/api/generated/metpy.plots.PlotGeometry.html index 5774db6b5c7..8c22a536b64 100644 --- a/dev/api/generated/metpy.plots.PlotGeometry.html +++ b/dev/api/generated/metpy.plots.PlotGeometry.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    PlotGeometry#

    -class metpy.plots.PlotGeometry(**kwargs: Any)[source]#
    +class metpy.plots.PlotGeometry(**kwargs: Any)[source]#

    Plot collections of Shapely objects and customize their appearance.

    Attributes Summary

    @@ -1034,32 +1034,32 @@

    PlotGeometryMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1067,7 +1067,7 @@

    PlotGeometry
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1095,13 +1095,13 @@

    PlotGeometry
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1111,13 +1111,13 @@

    PlotGeometry
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1133,10 +1133,10 @@

    PlotGeometryold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1145,7 +1145,7 @@

    PlotGeometry
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1161,10 +1161,10 @@

    PlotGeometrylist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1173,19 +1173,19 @@

    PlotGeometry
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1194,11 +1194,11 @@

    PlotGeometry
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1209,7 +1209,7 @@

    PlotGeometry
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1230,19 +1230,19 @@

    PlotGeometry
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1263,7 +1263,7 @@

    PlotGeometry
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1278,17 +1278,17 @@

    PlotGeometry
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1297,7 +1297,7 @@

    PlotGeometry
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1439,7 +1439,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.PlotObs.html b/dev/api/generated/metpy.plots.PlotObs.html index b7f54845cad..f931839bb77 100644 --- a/dev/api/generated/metpy.plots.PlotObs.html +++ b/dev/api/generated/metpy.plots.PlotObs.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    PlotObs#

    -class metpy.plots.PlotObs(**kwargs: Any)[source]#
    +class metpy.plots.PlotObs(**kwargs: Any)[source]#

    The highest level class related to plotting observed surface and upperair data.

    This class collects all common methods no matter whether plotting a upper-level or surface data using station plots.

    @@ -1078,7 +1078,7 @@

    PlotObs#< time#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library.

    @@ -1124,32 +1124,32 @@

    PlotObs#<

    Methods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1157,7 +1157,7 @@

    PlotObs#<
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1192,13 +1192,13 @@

    PlotObs#<
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1208,13 +1208,13 @@

    PlotObs#<
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1230,10 +1230,10 @@

    PlotObs#< * old : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1242,7 +1242,7 @@

    PlotObs#<
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1258,10 +1258,10 @@

    PlotObs#<

  • handler (callable, None) – A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new), handler(name, old, new), or handler(name, old, new, self).

    • -

  • name (list, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1270,19 +1270,19 @@

    PlotObs#<
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1291,11 +1291,11 @@

    PlotObs#<
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1306,7 +1306,7 @@

    PlotObs#<
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1327,19 +1327,19 @@

    PlotObs#<
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1360,7 +1360,7 @@

    PlotObs#<
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1375,17 +1375,17 @@

    PlotObs#<
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1394,7 +1394,7 @@

    PlotObs#<
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1551,7 +1551,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.PlotScalar.html b/dev/api/generated/metpy.plots.PlotScalar.html index b4b66480e7d..28cbd7dcd74 100644 --- a/dev/api/generated/metpy.plots.PlotScalar.html +++ b/dev/api/generated/metpy.plots.PlotScalar.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    PlotScalar#

    -class metpy.plots.PlotScalar(**kwargs: Any)[source]#
    +class metpy.plots.PlotScalar(**kwargs: Any)[source]#

    Defines the common elements of 2D scalar plots for single scalar value fields.

    Most of the other traits here are for one or more of the specific plots. Currently this allows too many options for ContourPlot since it does not user image_range, for @@ -1080,7 +1080,7 @@

    PlotScalartime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1106,32 +1106,32 @@

    PlotScalarMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1139,7 +1139,7 @@

    PlotScalar
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1186,13 +1186,13 @@

    PlotScalar
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1202,13 +1202,13 @@

    PlotScalar
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1224,10 +1224,10 @@

    PlotScalarold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1236,7 +1236,7 @@

    PlotScalar
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1252,10 +1252,10 @@

    PlotScalarlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1264,19 +1264,19 @@

    PlotScalar
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1285,11 +1285,11 @@

    PlotScalar
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1300,7 +1300,7 @@

    PlotScalar
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1321,19 +1321,19 @@

    PlotScalar
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1354,7 +1354,7 @@

    PlotScalar
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1369,17 +1369,17 @@

    PlotScalar
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1388,7 +1388,7 @@

    PlotScalar
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1544,7 +1544,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.PlotSurfaceAnalysis.html b/dev/api/generated/metpy.plots.PlotSurfaceAnalysis.html index a9ab61655d9..b5a173596ff 100644 --- a/dev/api/generated/metpy.plots.PlotSurfaceAnalysis.html +++ b/dev/api/generated/metpy.plots.PlotSurfaceAnalysis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    PlotSurfaceAnalysis#

    -class metpy.plots.PlotSurfaceAnalysis(**kwargs: Any)[source]#
    +class metpy.plots.PlotSurfaceAnalysis(**kwargs: Any)[source]#

    Plot Surface Analysis Features.

    This class visualizes Surface Analysis features, including the parsed WPC Surface Analysis bulletins processed by the parse_wpc_surface_bulletin() function.

    @@ -1108,32 +1108,32 @@

    PlotSurfaceAnalysisMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1141,7 +1141,7 @@

    PlotSurfaceAnalysis
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1169,13 +1169,13 @@

    PlotSurfaceAnalysis
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1185,13 +1185,13 @@

    PlotSurfaceAnalysis
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1207,10 +1207,10 @@

    PlotSurfaceAnalysisold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1219,7 +1219,7 @@

    PlotSurfaceAnalysis
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1235,10 +1235,10 @@

    PlotSurfaceAnalysislist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1247,19 +1247,19 @@

    PlotSurfaceAnalysis
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1268,11 +1268,11 @@

    PlotSurfaceAnalysis
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1283,7 +1283,7 @@

    PlotSurfaceAnalysis
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1304,19 +1304,19 @@

    PlotSurfaceAnalysis
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1337,7 +1337,7 @@

    PlotSurfaceAnalysis
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1352,17 +1352,17 @@

    PlotSurfaceAnalysis
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1371,7 +1371,7 @@

    PlotSurfaceAnalysis
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1511,7 +1511,7 @@

    PlotSurfaceAnalysis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.PlotVector.html b/dev/api/generated/metpy.plots.PlotVector.html index 79ca70b8d2b..d50d89f55a1 100644 --- a/dev/api/generated/metpy.plots.PlotVector.html +++ b/dev/api/generated/metpy.plots.PlotVector.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    PlotVector#

    -class metpy.plots.PlotVector(**kwargs: Any)[source]#
    +class metpy.plots.PlotVector(**kwargs: Any)[source]#

    Defines common elements for 2D vector plots.

    This class collects common elements including the field trait, which is a tuple argument accepting two strings, for plotting 2D vector fields.

    @@ -1093,7 +1093,7 @@

    PlotVectortime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1119,32 +1119,32 @@

    PlotVectorMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1152,7 +1152,7 @@

    PlotVector
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1199,13 +1199,13 @@

    PlotVector
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1215,13 +1215,13 @@

    PlotVector
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1237,10 +1237,10 @@

    PlotVectorold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1249,7 +1249,7 @@

    PlotVector
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1265,10 +1265,10 @@

    PlotVectorlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1277,19 +1277,19 @@

    PlotVector
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1298,11 +1298,11 @@

    PlotVector
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1313,7 +1313,7 @@

    PlotVector
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1334,19 +1334,19 @@

    PlotVector
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1367,7 +1367,7 @@

    PlotVector
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1382,17 +1382,17 @@

    PlotVector
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1401,7 +1401,7 @@

    PlotVector
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1550,7 +1550,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.Plots2D.html b/dev/api/generated/metpy.plots.Plots2D.html index 50e51468e2c..902ab53e7b4 100644 --- a/dev/api/generated/metpy.plots.Plots2D.html +++ b/dev/api/generated/metpy.plots.Plots2D.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    Plots2D#

    -class metpy.plots.Plots2D(**kwargs: Any)[source]#
    +class metpy.plots.Plots2D(**kwargs: Any)[source]#

    The highest level class related to plotting 2D data.

    This class collects all common methods no matter whether plotting a scalar variable or vector. Primary settings common to all types of 2D plots include those for data subsets.

    @@ -1006,7 +1006,7 @@

    Plots2D#< time#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1032,32 +1032,32 @@

    Plots2D#<

    Methods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1065,7 +1065,7 @@

    Plots2D#<
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1106,13 +1106,13 @@

    Plots2D#<
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1122,13 +1122,13 @@

    Plots2D#<
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1144,10 +1144,10 @@

    Plots2D#< * old : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1156,7 +1156,7 @@

    Plots2D#<
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1172,10 +1172,10 @@

    Plots2D#<

  • handler (callable, None) – A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new), handler(name, old, new), or handler(name, old, new, self).

    • -

  • name (list, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1184,19 +1184,19 @@

    Plots2D#<
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1205,11 +1205,11 @@

    Plots2D#<
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1220,7 +1220,7 @@

    Plots2D#<
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1241,19 +1241,19 @@

    Plots2D#<
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1274,7 +1274,7 @@

    Plots2D#<
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1289,17 +1289,17 @@

    Plots2D#<
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1308,7 +1308,7 @@

    Plots2D#<
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1458,7 +1458,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.RasterPlot.html b/dev/api/generated/metpy.plots.RasterPlot.html index 6b25ab67237..a4d010f8d44 100644 --- a/dev/api/generated/metpy.plots.RasterPlot.html +++ b/dev/api/generated/metpy.plots.RasterPlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -778,7 +778,7 @@

    RasterPlot#

    -class metpy.plots.RasterPlot(**kwargs: Any)[source]#
    +class metpy.plots.RasterPlot(**kwargs: Any)[source]#

    Make raster plots by defining relevant traits.

    Attributes Summary

    @@ -1127,7 +1127,7 @@

    RasterPlottime#

    Set the valid time to be plotted as a datetime object.

    If a forecast hour is to be plotted the time should be set to the valid future time, which -can be done using the datetime and timedelta objects +can be done using the datetime and timedelta objects from the Python standard library. Note that this requires your data to have a time dimension coordinate.

    @@ -1153,32 +1153,32 @@

    RasterPlotMethods Documentation

    -__init__(*args: Any, **kwargs: Any) → None[source]#
    +__init__(*args: Any, **kwargs: Any) → None[source]#
    -add_traits(**traits: Any) → None[source]#
    +add_traits(**traits: Any) → None[source]#

    Dynamically add trait attributes to the HasTraits instance.

    -classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#
    +classmethod class_own_trait_events(name: str) → dict[str, EventHandler][source]#

    Get a dict of all event handlers defined on this class, not a parent.

    Works like event_handlers, except for excluding traits from parents.

    -classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_own_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traitlets defined on this class, not a parent.

    Works like class_traits, except for excluding traits from parents.

    -classmethod class_trait_names(**metadata: Any) → list[str][source]#
    +classmethod class_trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    This method is just like the trait_names() method, but is unbound.

    @@ -1186,7 +1186,7 @@

    RasterPlot
    -classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +classmethod class_traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    This method is just like the traits() method, but is unbound.

    @@ -1233,13 +1233,13 @@

    RasterPlot
    -has_trait(name: str) → bool[source]#
    +has_trait(name: str) → bool[source]#

    Returns True if the object has a trait with the specified name.

    -hold_trait_notifications() → Any[source]#
    +hold_trait_notifications() → Any[source]#

    Context manager for bundling trait change notifications and cross validation.

    Use this when doing multiple trait assignments (init, config), to avoid @@ -1249,13 +1249,13 @@

    RasterPlot
    -notify_change(change: Bunch) → None[source]#
    +notify_change(change: Bunch) → None[source]#

    Notify observers of a change event

    -observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +observe(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    @@ -1271,10 +1271,10 @@

    RasterPlotold : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.

    -

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list +

  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all +

  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

    • @@ -1283,7 +1283,7 @@

    RasterPlot
    -on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#
    +on_trait_change(handler: EventHandler | None = None, name: Sentinel | str | None = None, remove: bool = False) → None[source]#

    DEPRECATED: Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits @@ -1299,10 +1299,10 @@

    RasterPlotlist, str, None) – If None, the handler will apply to all traits. If a list +

  • name (list, str, None) – If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

    • -

  • remove (bool) – If False (the default), then install the handler. If True +

  • remove (bool) – If False (the default), then install the handler. If True then unintall it.

    • @@ -1311,19 +1311,19 @@

    RasterPlot
    -set_trait(name: str, value: Any) → None[source]#
    +set_trait(name: str, value: Any) → None[source]#

    Forcibly sets trait attribute, including read-only attributes.

    -setup_instance(**kwargs: Any) → None[source]#
    +setup_instance(**kwargs: Any) → None[source]#

    This is called before self.__init__ is called.

    -trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#
    +trait_defaults(*names: str, **metadata: Any) → dict[str, Any] | Sentinel[source]#

    Return a trait’s default value or a dictionary of them

    Notes

    Dynamically generated default values may @@ -1332,11 +1332,11 @@

    RasterPlot
    -classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#
    +classmethod trait_events(name: str | None = None) → dict[str, EventHandler][source]#

    Get a dict of all the event handlers of this class.

    Parameters:
    -

    name (str (default: None)) – The name of a trait of this class. If name is None then all +

    name (str (default: None)) – The name of a trait of this class. If name is None then all the event handlers of this class will be returned instead.

    Returns:
    @@ -1347,7 +1347,7 @@

    RasterPlot
    -trait_has_value(name: str) → bool[source]#
    +trait_has_value(name: str) → bool[source]#

    Returns True if the specified trait has a value.

    This will return false even if getattr would return a dynamically generated default value. These default values @@ -1368,19 +1368,19 @@

    RasterPlot
    -trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#
    +trait_metadata(traitname: str, key: str, default: Any = None) → Any[source]#

    Get metadata values for trait by key.

    -trait_names(**metadata: Any) → list[str][source]#
    +trait_names(**metadata: Any) → list[str][source]#

    Get a list of all the names of this class’ traits.

    -trait_values(**metadata: Any) → dict[str, Any][source]#
    +trait_values(**metadata: Any) → dict[str, Any][source]#

    A dict of trait names and their values.

    The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should @@ -1401,7 +1401,7 @@

    RasterPlot
    -traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#
    +traits(**metadata: Any) → dict[str, TraitType[Any, Any]][source]#

    Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

    The TraitTypes returned don’t know anything about the values @@ -1416,17 +1416,17 @@

    RasterPlot
    -unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#
    +unobserve(handler: Callable[[...], Any], names: Sentinel | str | Iterable[Sentinel | str] = traitlets.All, type: Sentinel | str = 'change') → None[source]#

    Remove a trait change handler.

    This is used to unregister handlers to trait change notifications.

    Parameters:

    • handler (callable) – The callable called when a trait attribute changes.

      • -

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be +

    • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.

      • -

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler +

    • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

    @@ -1435,7 +1435,7 @@

    RasterPlot
    -unobserve_all(name: str | Any = traitlets.All) → None[source]#
    +unobserve_all(name: str | Any = traitlets.All) → None[source]#

    Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.

    @@ -1586,7 +1586,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.RidgeAxis.html b/dev/api/generated/metpy.plots.RidgeAxis.html index 57eb1945222..0033c28705a 100644 --- a/dev/api/generated/metpy.plots.RidgeAxis.html +++ b/dev/api/generated/metpy.plots.RidgeAxis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,9 +785,9 @@

    RidgeAxis
    Parameters:
      -

    • color (str) – Color to use for the effect.

      • -

    • spacing (float) – The spacing between ticks in points. Default is 12.

      • -

    • length (float) – The length of the tick relative to spacing. Default is 0.5.

      • +

    • color (str) – Color to use for the effect.

      • +

    • spacing (float) – The spacing between ticks in points. Default is 12.

      • +

    • length (float) – The length of the tick relative to spacing. Default is 0.5.

    @@ -811,9 +811,9 @@

    RidgeAxis
    Parameters:
      -

    • color (str) – Color to use for the effect.

      • -

    • spacing (float) – The spacing between ticks in points. Default is 12.

      • -

    • length (float) – The length of the tick relative to spacing. Default is 0.5.

      • +

    • color (str) – Color to use for the effect.

      • +

    • spacing (float) – The spacing between ticks in points. Default is 12.

      • +

    • length (float) – The length of the tick relative to spacing. Default is 0.5.

    @@ -917,7 +917,7 @@

    RidgeAxis

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.ScallopedStroke.html b/dev/api/generated/metpy.plots.ScallopedStroke.html index dbf51d0246d..1de1ca0a071 100644 --- a/dev/api/generated/metpy.plots.ScallopedStroke.html +++ b/dev/api/generated/metpy.plots.ScallopedStroke.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,11 +786,11 @@

    ScallopedStroke
    Parameters:
      -

    • offset ((float, float)) – The (x, y) offset to apply to the path, in points. Defaults to no offset.

      • -

    • spacing (float) – The spacing between ticks in points. Defaults to 10.0.

      • -

    • side (str) – Side of the path scallops appear on from the reference of +

    • offset ((float, float)) – The (x, y) offset to apply to the path, in points. Defaults to no offset.

      • +

    • spacing (float) – The spacing between ticks in points. Defaults to 10.0.

      • +

    • side (str) – Side of the path scallops appear on from the reference of walking along the curve. Options are left and right. Defaults to 'left'.

      • -

    • length (float) – The length of the tick relative to spacing. Defaults to 1.414.

      • +

    • length (float) – The length of the tick relative to spacing. Defaults to 1.414.

    • kwargs – Extra keywords are stored and passed through to GraphicsContextBase.

    @@ -816,11 +816,11 @@

    ScallopedStroke
    Parameters:
      -

    • offset ((float, float)) – The (x, y) offset to apply to the path, in points. Defaults to no offset.

      • -

    • spacing (float) – The spacing between ticks in points. Defaults to 10.0.

      • -

    • side (str) – Side of the path scallops appear on from the reference of +

    • offset ((float, float)) – The (x, y) offset to apply to the path, in points. Defaults to no offset.

      • +

    • spacing (float) – The spacing between ticks in points. Defaults to 10.0.

      • +

    • side (str) – Side of the path scallops appear on from the reference of walking along the curve. Options are left and right. Defaults to 'left'.

      • -

    • length (float) – The length of the tick relative to spacing. Defaults to 1.414.

      • +

    • length (float) – The length of the tick relative to spacing. Defaults to 1.414.

    • kwargs – Extra keywords are stored and passed through to GraphicsContextBase.

    @@ -926,7 +926,7 @@

    ScallopedStroke

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.SkewT.html b/dev/api/generated/metpy.plots.SkewT.html index a59eee92d7b..4f0defcfcb3 100644 --- a/dev/api/generated/metpy.plots.SkewT.html +++ b/dev/api/generated/metpy.plots.SkewT.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -802,7 +802,7 @@

    SkewT#<

    • fig (matplotlib.figure.Figure, optional) – Source figure to use for plotting. If none is given, a new matplotlib.figure.Figure instance will be created.

      • -

    • rotation (float or int, optional) – Controls the rotation of temperature relative to horizontal. Given +

    • rotation (float or int, optional) – Controls the rotation of temperature relative to horizontal. Given in degrees counterclockwise from x-axis. Defaults to 30 degrees.

    • subplot (tuple[int, int, int] or matplotlib.gridspec.SubplotSpec instance, optional) – Controls the size/position of the created subplot. This allows creating the skewT as part of a collection of subplots. If subplot is a tuple, it @@ -810,9 +810,9 @@

      SkewT#< matplotlib.figure.Figure.add_subplot(). The matplotlib.gridspec.SubplotSpec can be created by using matplotlib.gridspec.GridSpec.

      • -

    • rect (tuple[float, float, float, float], optional) – Rectangle (left, bottom, width, height) in which to place the axes. This +

    • rect (tuple[float, float, float, float], optional) – Rectangle (left, bottom, width, height) in which to place the axes. This allows the user to place the axes at an arbitrary point on the figure.

      • -

    • aspect (float, int, or Literal['auto'], optional) – Aspect ratio (i.e. ratio of y-scale to x-scale) to maintain in the plot. +

    • aspect (float, int, or Literal['auto'], optional) – Aspect ratio (i.e. ratio of y-scale to x-scale) to maintain in the plot. Defaults to 80.5. Passing the string 'auto' tells matplotlib to handle the aspect ratio automatically (this is not recommended for SkewT).

    @@ -861,7 +861,7 @@

    SkewT#<

    • fig (matplotlib.figure.Figure, optional) – Source figure to use for plotting. If none is given, a new matplotlib.figure.Figure instance will be created.

      • -

    • rotation (float or int, optional) – Controls the rotation of temperature relative to horizontal. Given +

    • rotation (float or int, optional) – Controls the rotation of temperature relative to horizontal. Given in degrees counterclockwise from x-axis. Defaults to 30 degrees.

    • subplot (tuple[int, int, int] or matplotlib.gridspec.SubplotSpec instance, optional) – Controls the size/position of the created subplot. This allows creating the skewT as part of a collection of subplots. If subplot is a tuple, it @@ -869,9 +869,9 @@

      SkewT#< matplotlib.figure.Figure.add_subplot(). The matplotlib.gridspec.SubplotSpec can be created by using matplotlib.gridspec.GridSpec.

      • -

    • rect (tuple[float, float, float, float], optional) – Rectangle (left, bottom, width, height) in which to place the axes. This +

    • rect (tuple[float, float, float, float], optional) – Rectangle (left, bottom, width, height) in which to place the axes. This allows the user to place the axes at an arbitrary point on the figure.

      • -

    • aspect (float, int, or Literal['auto'], optional) – Aspect ratio (i.e. ratio of y-scale to x-scale) to maintain in the plot. +

    • aspect (float, int, or Literal['auto'], optional) – Aspect ratio (i.e. ratio of y-scale to x-scale) to maintain in the plot. Defaults to 80.5. Passing the string 'auto' tells matplotlib to handle the aspect ratio automatically (this is not recommended for SkewT).

    @@ -918,11 +918,11 @@

    SkewT#<

  • u (array-like) – U (East-West) component of wind

  • v (array-like) – V (North-South) component of wind

  • c (array-like, optional) – An optional array used to map colors to the barbs

    • -

  • xloc (float, optional) – Position for the barbs, in normalized axes coordinates, where 0.0 +

  • xloc (float, optional) – Position for the barbs, in normalized axes coordinates, where 0.0 denotes far left and 1.0 denotes far right. Defaults to far right.

    • -

  • x_clip_radius (float, optional) – Space, in normalized axes coordinates, to leave before clipping +

  • x_clip_radius (float, optional) – Space, in normalized axes coordinates, to leave before clipping wind barbs in the x-direction. Defaults to 0.1.

    • -

  • y_clip_radius (float, optional) – Space, in normalized axes coordinates, to leave above/below plot +

  • y_clip_radius (float, optional) – Space, in normalized axes coordinates, to leave above/below plot before clipping wind barbs in the y-direction. Defaults to 0.08.

  • plot_units (pint.Unit) – Units to plot in (performing conversion if necessary). Defaults to given units.

  • kwargs – Other keyword arguments to pass to barbs()

    • @@ -1037,7 +1037,7 @@

    SkewT#<

  • y (array-like) – 1-dimensional array of numeric y-values

  • x1 (array-like) – 1-dimensional array of numeric x-values

  • x2 (array-like) – 1-dimensional array of numeric x-values

    • -

  • which (str) – Specifies if positive, negative, or both areas are being shaded. +

  • which (str) – Specifies if positive, negative, or both areas are being shaded. Will be overridden by where.

  • kwargs – Other keyword arguments to pass to matplotlib.collections.PolyCollection

    • @@ -1064,7 +1064,7 @@

    SkewT#<

  • pressure (array-like) – Pressure values

  • t (array-like) – Temperature values

  • t_parcel (array-like) – Parcel path temperature values

    • -

  • limit_shading (bool) – Eliminate shading below the LCL or above the EL, default is True

    • +

  • limit_shading (bool) – Eliminate shading below the LCL or above the EL, default is True

  • kwargs – Other keyword arguments to pass to matplotlib.collections.PolyCollection

    • @@ -1230,7 +1230,7 @@

    Examples using

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.Squall.html b/dev/api/generated/metpy.plots.Squall.html index f95d4645cf7..74c80b8c2b4 100644 --- a/dev/api/generated/metpy.plots.Squall.html +++ b/dev/api/generated/metpy.plots.Squall.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,8 +784,8 @@

    Squall#
    Parameters:
      -

    • color (str) – Color to use for the effect.

      • -

    • spacing (float) – Spacing between symbols along path (in points).

      • +

    • color (str) – Color to use for the effect.

      • +

    • spacing (float) – Spacing between symbols along path (in points).

    @@ -824,8 +824,8 @@

    Squall#
    Parameters:
      -

    • color (str) – Color to use for the effect.

      • -

    • spacing (float) – Spacing between symbols along path (in points).

      • +

    • color (str) – Color to use for the effect.

      • +

    • spacing (float) – Spacing between symbols along path (in points).

    @@ -930,7 +930,7 @@

    Squall#

    - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

    diff --git a/dev/api/generated/metpy.plots.StationPlot.html b/dev/api/generated/metpy.plots.StationPlot.html index ff7af6c63c1..3ddc475ee66 100644 --- a/dev/api/generated/metpy.plots.StationPlot.html +++ b/dev/api/generated/metpy.plots.StationPlot.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -792,8 +792,8 @@

    StationPlotmatplotlib.axes.Axes) – The Axes for plotting

  • x (array-like) – The x location of the stations in the plot

  • y (array-like) – The y location of the stations in the plot

    • -

  • fontsize (int) – The fontsize to use for drawing text

    • -

  • spacing (int) – The spacing, in points, that corresponds to a single increment between +

  • fontsize (int) – The fontsize to use for drawing text

    • +

  • spacing (int) – The spacing, in points, that corresponds to a single increment between station plot elements.

  • transform (matplotlib.transforms.Transform) – The default transform to apply to the x and y positions when plotting. Works with anything compatible with the Transform interface.

    • @@ -856,8 +856,8 @@

    StationPlotmatplotlib.axes.Axes) – The Axes for plotting

  • x (array-like) – The x location of the stations in the plot

  • y (array-like) – The y location of the stations in the plot

    • -

  • fontsize (int) – The fontsize to use for drawing text

    • -

  • spacing (int) – The spacing, in points, that corresponds to a single increment between +

  • fontsize (int) – The fontsize to use for drawing text

    • +

  • spacing (int) – The spacing, in points, that corresponds to a single increment between station plot elements.

  • transform (matplotlib.transforms.Transform) – The default transform to apply to the x and y positions when plotting. Works with anything compatible with the Transform interface.

    • @@ -929,13 +929,13 @@

    StationPlot
    Parameters:
      -

    • location (str or tuple[float, float]) – The offset (relative to center) to plot this parameter. If str, should be one of +

    • location (str or tuple[float, float]) – The offset (relative to center) to plot this parameter. If str, should be one of ‘C’, ‘N’, ‘NE’, ‘E’, ‘SE’, ‘S’, ‘SW’, ‘W’, or ‘NW’. Otherwise, should be a tuple specifying the number of increments in the x and y directions; increments are multiplied by spacing to give offsets in x and y relative to the center.

    • parameter (array-like) – The numeric values that should be plotted

      • -

    • formatter (str or Callable, optional) – How to format the data as a string for plotting. If a string, it should be -compatible with the format() builtin. If a callable, this should take a +

    • formatter (str or Callable, optional) – How to format the data as a string for plotting. If a string, it should be +compatible with the format() builtin. If a callable, this should take a value and return a string. Defaults to ‘z0.f’.

    • plot_units (pint.unit) – Units to plot in (performing conversion if necessary). Defaults to given units.

    • kwargs – Additional keyword arguments to use for matplotlib’s plotting functions.

      • @@ -961,7 +961,7 @@

      StationPlot
      Parameters:
        -

      • location (str or tuple[float, float]) – The offset (relative to center) to plot this parameter. If str, should be one of +

      • location (str or tuple[float, float]) – The offset (relative to center) to plot this parameter. If str, should be one of ‘C’, ‘N’, ‘NE’, ‘E’, ‘SE’, ‘S’, ‘SW’, ‘W’, or ‘NW’. Otherwise, should be a tuple specifying the number of increments in the x and y directions; increments are multiplied by spacing to give offsets in x and y relative to the center.

        • @@ -1013,11 +1013,11 @@

        StationPlot
        Parameters:
          -

        • location (str or tuple[float, float]) – The offset (relative to center) to plot this parameter. If str, should be one of +

        • location (str or tuple[float, float]) – The offset (relative to center) to plot this parameter. If str, should be one of ‘C’, ‘N’, ‘NE’, ‘E’, ‘SE’, ‘S’, ‘SW’, ‘W’, or ‘NW’. Otherwise, should be a tuple specifying the number of increments in the x and y directions; increments are multiplied by spacing to give offsets in x and y relative to the center.

          • -

        • text (Sequence[str]) – The strings that should be plotted

          • +

        • text (Sequence[str]) – The strings that should be plotted

        • kwargs – Additional keyword arguments to use for matplotlib’s plotting functions.

        @@ -1141,7 +1141,7 @@

        Examples using

        - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

        diff --git a/dev/api/generated/metpy.plots.StationPlotLayout.html b/dev/api/generated/metpy.plots.StationPlotLayout.html index 068414bfe65..59f9927a360 100644 --- a/dev/api/generated/metpy.plots.StationPlotLayout.html +++ b/dev/api/generated/metpy.plots.StationPlotLayout.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -866,9 +866,9 @@

        StationPlotLayout
        Parameters:
          -

        • u_name (str) – The name of the parameter for the u-component for barbs, which is used as +

        • u_name (str) – The name of the parameter for the u-component for barbs, which is used as a key to pull data out of the data container passed to plot().

          • -

        • v_name (str) – The name of the parameter for the v-component for barbs, which is used as +

        • v_name (str) – The name of the parameter for the v-component for barbs, which is used as a key to pull data out of the data container passed to plot().

        • units (pint.Unit, optional) – The units to use for plotting. Data will be converted to this unit before conversion to a string. If not specified, no conversion is done.

          • @@ -895,10 +895,10 @@

          StationPlotLayout
          Parameters:
            -

          • location (str or tuple[float, float]) – The offset (relative to center) to plot this value. If str, should be one of +

          • location (str or tuple[float, float]) – The offset (relative to center) to plot this value. If str, should be one of ‘C’, ‘N’, ‘NE’, ‘E’, ‘SE’, ‘S’, ‘SW’, ‘W’, or ‘NW’. Otherwise, should be a tuple specifying the number of increments in the x and y directions.

            • -

          • name (str) – The name of the parameter, which is used as a key to pull data out of the +

          • name (str) – The name of the parameter, which is used as a key to pull data out of the data container passed to plot().

          • symbol_mapper (Callable) – Controls converting data values to unicode code points for the metpy.plots.wx_symbols.wx_symbol_font font. This should take a value and @@ -926,10 +926,10 @@

            StationPlotLayout
            Parameters:
              -

            • location (str or tuple(float, float)) – The offset (relative to center) to plot this value. If str, should be one of +

            • location (str or tuple(float, float)) – The offset (relative to center) to plot this value. If str, should be one of ‘C’, ‘N’, ‘NE’, ‘E’, ‘SE’, ‘S’, ‘SW’, ‘W’, or ‘NW’. Otherwise, should be a tuple specifying the number of increments in the x and y directions.

              • -

            • name (str) – The name of the parameter, which is used as a key to pull data out of the +

            • name (str) – The name of the parameter, which is used as a key to pull data out of the data container passed to plot().

            • kwargs – Additional keyword arguments to use for matplotlib’s plotting functions.

            @@ -955,13 +955,13 @@

            StationPlotLayout
            Parameters:
              -

            • location (str or tuple[float, float]) – The offset (relative to center) to plot this value. If str, should be one of +

            • location (str or tuple[float, float]) – The offset (relative to center) to plot this value. If str, should be one of ‘C’, ‘N’, ‘NE’, ‘E’, ‘SE’, ‘S’, ‘SW’, ‘W’, or ‘NW’. Otherwise, should be a tuple specifying the number of increments in the x and y directions.

              • -

            • name (str) – The name of the parameter, which is used as a key to pull data out of the +

            • name (str) – The name of the parameter, which is used as a key to pull data out of the data container passed to plot().

              • -

            • fmt (str or Callable, optional) – How to format the data as a string for plotting. If a string, it should be -compatible with the format() builtin. If a callable, this should take a +

            • fmt (str or Callable, optional) – How to format the data as a string for plotting. If a string, it should be +compatible with the format() builtin. If a callable, this should take a value and return a string. Defaults to ‘0.f’.

            • units (pint.Unit, optional) – The units to use for plotting. Data will be converted to this unit before conversion to a string. If not specified, no conversion is done.

              • @@ -1030,7 +1030,7 @@

              StationPlotLayout

              • plotter (StationPlot) – StationPlot to use to plot the data. This controls the axes, spacing, station locations, etc.

                • -

              • data_dict (dict[str, array-like]) – Data container that maps a name to an array of data. Data from this object +

              • data_dict (dict[str, array-like]) – Data container that maps a name to an array of data. Data from this object will be used to fill out the station plot.

            @@ -1187,7 +1187,7 @@

            Examples using

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.StationaryFront.html b/dev/api/generated/metpy.plots.StationaryFront.html index 8962e44fca3..5b00423071a 100644 --- a/dev/api/generated/metpy.plots.StationaryFront.html +++ b/dev/api/generated/metpy.plots.StationaryFront.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,11 +785,11 @@

            StationaryFront
            Parameters:
              -

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. +

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. Defaults to alternating red and blue.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults to False.

            @@ -831,11 +831,11 @@

            StationaryFront
            Parameters:
              -

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. +

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. Defaults to alternating red and blue.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults to False.

            @@ -948,7 +948,7 @@

            Examples using

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.StationaryFrontogenesis.html b/dev/api/generated/metpy.plots.StationaryFrontogenesis.html index e4544345f12..18b2f72e42b 100644 --- a/dev/api/generated/metpy.plots.StationaryFrontogenesis.html +++ b/dev/api/generated/metpy.plots.StationaryFrontogenesis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,11 +785,11 @@

            StationaryFrontogenesis
            Parameters:
              -

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. +

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. Defaults to alternating red and blue.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults to False.

            @@ -831,11 +831,11 @@

            StationaryFrontogenesis
            Parameters:
              -

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. +

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. Defaults to alternating red and blue.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults to False.

            @@ -941,7 +941,7 @@

            StationaryFrontogenesis

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.StationaryFrontolysis.html b/dev/api/generated/metpy.plots.StationaryFrontolysis.html index 3cb4e04b7a7..eb7ecad3c45 100644 --- a/dev/api/generated/metpy.plots.StationaryFrontolysis.html +++ b/dev/api/generated/metpy.plots.StationaryFrontolysis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,11 +785,11 @@

            StationaryFrontolysis
            Parameters:
              -

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. +

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. Defaults to alternating red and blue.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults to False.

            @@ -831,11 +831,11 @@

            StationaryFrontolysis
            Parameters:
              -

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. +

            • colors (Sequence[str] or Sequence[tuple[float]]) – Matplotlib color identifiers to cycle between on the two different front styles. Defaults to alternating red and blue.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbols should be flipped to the other side of the path. Defaults to False.

            @@ -941,7 +941,7 @@

            StationaryFrontolysis

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.WarmFront.html b/dev/api/generated/metpy.plots.WarmFront.html index 769970b3a9e..bc8a68d0283 100644 --- a/dev/api/generated/metpy.plots.WarmFront.html +++ b/dev/api/generated/metpy.plots.WarmFront.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,12 +784,12 @@

            WarmFront
            Parameters:
              -

            • color (str or tuple[float]) – Color to use for the effect.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

            • color (str or tuple[float]) – Color to use for the effect.

              • +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

              • -

            • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

              • +

            • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

            @@ -829,12 +829,12 @@

            WarmFront
            Parameters:
              -

            • color (str or tuple[float]) – Color to use for the effect.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

            • color (str or tuple[float]) – Color to use for the effect.

              • +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

              • -

            • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

              • +

            • filled (bool) – Whether the symbol should be filled with the color. Defaults to True.

            @@ -949,7 +949,7 @@

            Examples using

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.WarmFrontogenesis.html b/dev/api/generated/metpy.plots.WarmFrontogenesis.html index 05c782eff95..341ba8a4860 100644 --- a/dev/api/generated/metpy.plots.WarmFrontogenesis.html +++ b/dev/api/generated/metpy.plots.WarmFrontogenesis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,10 +784,10 @@

            WarmFrontogenesis
            Parameters:
              -

            • color (str or tuple[float]) – Color to use for the effect.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

            • color (str or tuple[float]) – Color to use for the effect.

              • +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

            @@ -828,10 +828,10 @@

            WarmFrontogenesis
            Parameters:
              -

            • color (str or tuple[float]) – Color to use for the effect.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

            • color (str or tuple[float]) – Color to use for the effect.

              • +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

            @@ -937,7 +937,7 @@

            WarmFrontogenesis

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.WarmFrontolysis.html b/dev/api/generated/metpy.plots.WarmFrontolysis.html index 68317fe6735..b7b4dc6a5dc 100644 --- a/dev/api/generated/metpy.plots.WarmFrontolysis.html +++ b/dev/api/generated/metpy.plots.WarmFrontolysis.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,10 +784,10 @@

            WarmFrontolysis
            Parameters:
              -

            • color (str or tuple[float]) – Color to use for the effect.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

            • color (str or tuple[float]) – Color to use for the effect.

              • +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

            @@ -828,10 +828,10 @@

            WarmFrontolysis
            Parameters:
              -

            • color (str or tuple[float]) – Color to use for the effect.

              • -

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • -

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • -

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults +

            • color (str or tuple[float]) – Color to use for the effect.

              • +

            • size (int or float) – The size of the markers to plot in points. Defaults to 10.

              • +

            • spacing (int or float) – The spacing between markers in normalized coordinates. Defaults to 1.

              • +

            • flip (bool) – Whether the symbol should be flipped to the other side of the path. Defaults to False.

            @@ -937,7 +937,7 @@

            WarmFrontolysis

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.add_metpy_logo.html b/dev/api/generated/metpy.plots.add_metpy_logo.html index 4f8a4db932e..dcbc51555d3 100644 --- a/dev/api/generated/metpy.plots.add_metpy_logo.html +++ b/dev/api/generated/metpy.plots.add_metpy_logo.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,10 +785,10 @@

            add_metpy_logoParameters:

            • fig (matplotlib.figure) – The figure instance used for plotting

              • -

            • x (int) – x position padding in pixels

              • -

            • y (float) – y position padding in pixels

              • -

            • zorder (int) – The zorder of the logo

              • -

            • size (str) – Size of logo to be used. Can be ‘small’ for 75 px square or ‘large’ for +

            • x (int) – x position padding in pixels

              • +

            • y (float) – y position padding in pixels

              • +

            • zorder (int) – The zorder of the logo

              • +

            • size (str) – Size of logo to be used. Can be ‘small’ for 75 px square or ‘large’ for 150 px square.

            @@ -945,7 +945,7 @@

            Examples using

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.add_timestamp.html b/dev/api/generated/metpy.plots.add_timestamp.html index b33608ee5d0..598241a620e 100644 --- a/dev/api/generated/metpy.plots.add_timestamp.html +++ b/dev/api/generated/metpy.plots.add_timestamp.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,13 +785,13 @@

            add_timestampParameters:

            • ax (matplotlib.axes.Axes) – The Axes instance used for plotting

              • -

            • time (datetime.datetime (or any object with a compatible strftime method)) – Specific time to be plotted - datetime.now(UTC) will be use if not specified

              • -

            • x (float) – Relative x position on the axes of the timestamp

              • -

            • y (float) – Relative y position on the axes of the timestamp

              • -

            • ha (str) – Horizontal alignment of the time stamp string

              • -

            • high_contrast (bool) – Outline text for increased contrast

              • -

            • pretext (str) – Text to appear before the timestamp, optional. Defaults to ‘Created: ‘

              • -

            • time_format (str) – Display format of time, optional. Defaults to ISO format.

              • +

            • time (datetime.datetime (or any object with a compatible strftime method)) – Specific time to be plotted - datetime.now(UTC) will be use if not specified

              • +

            • x (float) – Relative x position on the axes of the timestamp

              • +

            • y (float) – Relative y position on the axes of the timestamp

              • +

            • ha (str) – Horizontal alignment of the time stamp string

              • +

            • high_contrast (bool) – Outline text for increased contrast

              • +

            • pretext (str) – Text to appear before the timestamp, optional. Defaults to ‘Created: ‘

              • +

            • time_format (str) – Display format of time, optional. Defaults to ISO format.

            Returns:
            @@ -905,7 +905,7 @@

            Examples using

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.add_unidata_logo.html b/dev/api/generated/metpy.plots.add_unidata_logo.html index 143013cb3e7..a77ac0ecc55 100644 --- a/dev/api/generated/metpy.plots.add_unidata_logo.html +++ b/dev/api/generated/metpy.plots.add_unidata_logo.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -785,10 +785,10 @@

            add_unidata_logoParameters:

            • fig (matplotlib.figure) – The figure instance used for plotting

              • -

            • x (int) – x position padding in pixels

              • -

            • y (float) – y position padding in pixels

              • -

            • zorder (int) – The zorder of the logo

              • -

            • size (str) – Size of logo to be used. Can be ‘small’ for 75 px square or ‘large’ for +

            • x (int) – x position padding in pixels

              • +

            • y (float) – y position padding in pixels

              • +

            • zorder (int) – The zorder of the logo

              • +

            • size (str) – Size of logo to be used. Can be ‘small’ for 75 px square or ‘large’ for 150 px square.

            @@ -884,7 +884,7 @@

            add_unidata_logo

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.convert_gempak_color.html b/dev/api/generated/metpy.plots.convert_gempak_color.html index a3ea76f82e9..b68b89714bf 100644 --- a/dev/api/generated/metpy.plots.convert_gempak_color.html +++ b/dev/api/generated/metpy.plots.convert_gempak_color.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,8 +786,8 @@

            convert_gempak_color
            Parameters:
              -

            • c (int or Sequence[int]) – GEMPAK color number(s)

              • -

            • style (str, optional) – The GEMPAK ‘device’ to use to interpret color numbers. May be ‘psc’ +

            • c (int or Sequence[int]) – GEMPAK color number(s)

              • +

            • style (str, optional) – The GEMPAK ‘device’ to use to interpret color numbers. May be ‘psc’ (the default; best for a white background) or ‘xw’ (best for a black background).

            @@ -883,7 +883,7 @@

            convert_gempak_color

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.ctables.ColortableRegistry.html b/dev/api/generated/metpy.plots.ctables.ColortableRegistry.html index 7f726d44dd5..b73fd953179 100644 --- a/dev/api/generated/metpy.plots.ctables.ColortableRegistry.html +++ b/dev/api/generated/metpy.plots.ctables.ColortableRegistry.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -859,7 +859,7 @@

            ColortableRegistryParameters:
            @@ -893,7 +893,7 @@

            ColortableRegistry
            Parameters:
            -

            name (str) – The name under which the color table will be stored

            +

            name (str) – The name under which the color table will be stored

            Returns:

            matplotlib.colors.ListedColormap – The color table corresponding to name

            @@ -909,7 +909,7 @@

            ColortableRegistry
            Parameters:
              -

            • name (str) – The name under which the color table will be stored

              • +

            • name (str) – The name under which the color table will be stored

            • boundaries (array-like) – The list of boundaries for the norm

            @@ -928,9 +928,9 @@

            ColortableRegistry
            Parameters:
              -

            • name (str) – The name under which the color table will be stored

              • -

            • start (float) – The starting boundary

              • -

            • end (float) – The ending boundary

              • +

            • name (str) – The name under which the color table will be stored

              • +

            • start (float) – The starting boundary

              • +

            • end (float) – The ending boundary

            Returns:
            @@ -949,9 +949,9 @@

            ColortableRegistry
            Parameters:
              -

            • name (str) – The name under which the color table will be stored

              • -

            • start (float) – The starting boundary

              • -

            • step (float) – The step between boundaries

              • +

            • name (str) – The name under which the color table will be stored

              • +

            • start (float) – The starting boundary

              • +

            • step (float) – The step between boundaries

            Returns:
            @@ -992,7 +992,7 @@

            ColortableRegistry
            Parameters:
            -

            path (str) – The path to the directory with the color tables

            +

            path (str) – The path to the directory with the color tables

            @@ -1004,8 +1004,8 @@

            ColortableRegistry
            Parameters:
              -

            • pkg (str) – The package containing the resource directory

              • -

            • path (str) – The path to the directory with the color tables

              • +

            • pkg (str) – The package containing the resource directory

              • +

            • path (str) – The path to the directory with the color tables

            @@ -1140,7 +1140,7 @@

            ColortableRegistry

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.ctables.colortables.html b/dev/api/generated/metpy.plots.ctables.colortables.html index ad26ae82a2f..da4086f1630 100644 --- a/dev/api/generated/metpy.plots.ctables.colortables.html +++ b/dev/api/generated/metpy.plots.ctables.colortables.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -870,7 +870,7 @@

            colortables

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.ctables.convert_gempak_table.html b/dev/api/generated/metpy.plots.ctables.convert_gempak_table.html index 651d4974318..d696eebd1d9 100644 --- a/dev/api/generated/metpy.plots.ctables.convert_gempak_table.html +++ b/dev/api/generated/metpy.plots.ctables.convert_gempak_table.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -878,7 +878,7 @@

            convert_gempak_table

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.ctables.html b/dev/api/generated/metpy.plots.ctables.html index 88bd4a23d06..78c5b509a71 100644 --- a/dev/api/generated/metpy.plots.ctables.html +++ b/dev/api/generated/metpy.plots.ctables.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -868,7 +868,7 @@

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.ctables.read_colortable.html b/dev/api/generated/metpy.plots.ctables.read_colortable.html index 9df51e3993c..768d6589bd1 100644 --- a/dev/api/generated/metpy.plots.ctables.read_colortable.html +++ b/dev/api/generated/metpy.plots.ctables.read_colortable.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -880,7 +880,7 @@

            read_colortable

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.html b/dev/api/generated/metpy.plots.html index cd0bd3a0588..2142f9aeafb 100644 --- a/dev/api/generated/metpy.plots.html +++ b/dev/api/generated/metpy.plots.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -971,7 +971,7 @@

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.read_colortable.html b/dev/api/generated/metpy.plots.read_colortable.html index e22484930ef..00439ad2ff4 100644 --- a/dev/api/generated/metpy.plots.read_colortable.html +++ b/dev/api/generated/metpy.plots.read_colortable.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -880,7 +880,7 @@

            read_colortable

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.plots.wx_code_to_numeric.html b/dev/api/generated/metpy.plots.wx_code_to_numeric.html index dfa4ece4a67..02af5156568 100644 --- a/dev/api/generated/metpy.plots.wx_code_to_numeric.html +++ b/dev/api/generated/metpy.plots.wx_code_to_numeric.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,7 +786,7 @@

            wx_code_to_numericsfc_df.wxcodes.fillna('').

            Parameters:
            -

            codes (Sequence[str]) – String values of METAR weather codes

            +

            codes (Sequence[str]) – String values of METAR weather codes

            Returns:

            numpy.ndarray – numeric codes of current weather symbols from the wx_code_map for use in plotting.

            @@ -880,7 +880,7 @@

            wx_code_to_numeric

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.units.html b/dev/api/generated/metpy.units.html index 15405e8ba66..2eaf5b8c454 100644 --- a/dev/api/generated/metpy.units.html +++ b/dev/api/generated/metpy.units.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -891,7 +891,7 @@

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.units.pandas_dataframe_to_unit_arrays.html b/dev/api/generated/metpy.units.pandas_dataframe_to_unit_arrays.html index d21e84b1d77..45540f7c621 100644 --- a/dev/api/generated/metpy.units.pandas_dataframe_to_unit_arrays.html +++ b/dev/api/generated/metpy.units.pandas_dataframe_to_unit_arrays.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -784,7 +784,7 @@

            pandas_dataframe_to_unit_arraysParameters:

            • df (pandas.DataFrame) – Data in pandas dataframe.

              • -

            • column_units (dict) – Dictionary of units to attach to columns of the dataframe. Overrides +

            • column_units (dict) – Dictionary of units to attach to columns of the dataframe. Overrides the units attribute if it is attached to the dataframe.

            @@ -884,7 +884,7 @@

            pandas_dataframe_to_unit_arrays

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.units.setup_registry.html b/dev/api/generated/metpy.units.setup_registry.html index dc3a737aa81..9cca16ed906 100644 --- a/dev/api/generated/metpy.units.setup_registry.html +++ b/dev/api/generated/metpy.units.setup_registry.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -868,7 +868,7 @@

            setup_registry

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.xarray.grid_deltas_from_dataarray.html b/dev/api/generated/metpy.xarray.grid_deltas_from_dataarray.html index 3b582a22d9e..1c86100ecea 100644 --- a/dev/api/generated/metpy.xarray.grid_deltas_from_dataarray.html +++ b/dev/api/generated/metpy.xarray.grid_deltas_from_dataarray.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -786,7 +786,7 @@

            grid_deltas_from_dataarrayParameters:

            • f (xarray.DataArray) – Parsed DataArray (metpy_crs coordinate must be available for kind=”actual”)

              • -

            • kind (str) – Type of grid delta to calculate. “actual” returns true distances as calculated from +

            • kind (str) – Type of grid delta to calculate. “actual” returns true distances as calculated from longitude and latitude via lat_lon_grid_deltas. “nominal” returns horizontal differences in the data’s coordinate space, either in degrees (for lat/lon CRS) or meters (for y/x CRS). “default” behaves like “actual” for datasets with a lat/lon CRS @@ -800,7 +800,7 @@

              grid_deltas_from_dataarray

              See also

              -

              None

              +

              None

            @@ -890,7 +890,7 @@

            grid_deltas_from_dataarray

            - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

            diff --git a/dev/api/generated/metpy.xarray.html b/dev/api/generated/metpy.xarray.html index 3b6ecbff701..1dbec8601a1 100644 --- a/dev/api/generated/metpy.xarray.html +++ b/dev/api/generated/metpy.xarray.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -811,7 +811,7 @@

            Accessors
            Parameters:
            -

            coordinates (dict or None) – Mapping from axis types (‘time’, ‘vertical’, ‘y’, ‘latitude’, ‘x’, ‘longitude’) to +

            coordinates (dict or None) – Mapping from axis types (‘time’, ‘vertical’, ‘y’, ‘latitude’, ‘x’, ‘longitude’) to coordinates of this DataArray. Coordinates can either be specified directly or by their name. If None, clears the _metpy_axis attribute on all coordinates, which will trigger reparsing of all coordinates on next access.

            @@ -832,7 +832,7 @@

            Accessors
            Parameters:
              -

            • cf_attributes (dict, optional) – Dictionary of CF projection attributes

              • +

            • cf_attributes (dict, optional) – Dictionary of CF projection attributes

            • kwargs (optional) – CF projection attributes specified as keyword arguments

            @@ -851,7 +851,7 @@

            Accessors
            Parameters:
            -

            force (bool, optional) – If force is true, overwrite latitude and longitude coordinates if they exist, +

            force (bool, optional) – If force is true, overwrite latitude and longitude coordinates if they exist, otherwise, raise a RuntimeError if such coordinates exist.

            Returns:
            @@ -870,7 +870,7 @@

            Accessors
            Parameters:
              -

            • force (bool, optional) – If force is true, overwrite y and x coordinates if they exist, otherwise, raise a +

            • force (bool, optional) – If force is true, overwrite y and x coordinates if they exist, otherwise, raise a RuntimeError if such coordinates exist.

            • tolerance (pint.Quantity) – Maximum range tolerated when collapsing projected y and x coordinates from 2D to 1D. Defaults to 1 meter.

              • @@ -953,7 +953,7 @@

              Accessors
              Parameters:
              -

              args (str) – Strings describing the axes type(s) to obtain. Currently understood types are +

              args (str) – Strings describing the axes type(s) to obtain. Currently understood types are ‘time’, ‘vertical’, ‘y’, ‘latitude’, ‘x’, and ‘longitude’.

              @@ -990,7 +990,7 @@

              Accessors
              Parameters:
              -

              axis (str or int) – Identifier for an axis. Can be an axis number (integer), dimension coordinate +

              axis (str or int) – Identifier for an axis. Can be an axis number (integer), dimension coordinate name (string) or a standard axis type (string).

              @@ -1002,7 +1002,7 @@

              Accessors
              Parameters:
              -

              axis (str or int) – Identifier for an axis. Can be an axis number (integer), dimension coordinate +

              axis (str or int) – Identifier for an axis. Can be an axis number (integer), dimension coordinate name (string) or a standard axis type (string).

              @@ -1140,7 +1140,7 @@

              Accessors
              Parameters:
                -

              • cf_attributes (dict, optional) – Dictionary of CF projection attributes

                • +

              • cf_attributes (dict, optional) – Dictionary of CF projection attributes

              • kwargs (optional) – CF projection attributes specified as keyword arguments

              @@ -1163,7 +1163,7 @@

              Accessors
              Parameters:
              -

              force (bool, optional) – If force is true, overwrite latitude and longitude coordinates if they exist, +

              force (bool, optional) – If force is true, overwrite latitude and longitude coordinates if they exist, otherwise, raise a RuntimeError if such coordinates exist.

              Returns:
              @@ -1183,7 +1183,7 @@

              Accessors
              Parameters:
                -

              • force (bool, optional) – If force is true, overwrite y and x coordinates if they exist, otherwise, raise a +

              • force (bool, optional) – If force is true, overwrite y and x coordinates if they exist, otherwise, raise a RuntimeError if such coordinates exist.

              • tolerance (pint.Quantity) – Maximum range tolerated when collapsing projected y and x coordinates from 2D to 1D. Defaults to 1 meter.

                • @@ -1227,9 +1227,9 @@

                Accessors
                Parameters:
                  -

                • varname (str or Sequence[str], optional) – Name of the variable(s) to extract from the dataset while parsing for CF metadata. +

                • varname (str or Sequence[str], optional) – Name of the variable(s) to extract from the dataset while parsing for CF metadata. Defaults to all variables.

                  • -

                • coordinates (dict, optional) – Dictionary mapping CF axis types to coordinates of the variable(s). Only specify +

                • coordinates (dict, optional) – Dictionary mapping CF axis types to coordinates of the variable(s). Only specify if you wish to override MetPy’s automatic parsing of some axis type(s).

                @@ -1266,8 +1266,8 @@

                Accessors
                Parameters:
                  -

                • attribute (str,) – Name of attribute to update

                  • -

                • mapping (dict or Callable) – Either a dict, with keys as variable names and values as attribute values to set, +

                • attribute (str,) – Name of attribute to update

                  • +

                • mapping (dict or Callable) – Either a dict, with keys as variable names and values as attribute values to set, or a callable, which must accept one positional argument (variable name) and arbitrary keyword arguments (all existing variable attributes). If a variable name is not present/the callable returns None, the attribute will not be updated.

                  • @@ -1431,7 +1431,7 @@

                  Functions

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/api/index.html b/dev/api/index.html index 9984789757b..a85b804821c 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -43,7 +43,7 @@ - + @@ -76,7 +76,7 @@ - + @@ -879,7 +879,7 @@

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/api/references.html b/dev/api/references.html index e78a594b097..bcdb34fae9f 100644 --- a/dev/api/references.html +++ b/dev/api/references.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -1145,7 +1145,7 @@

                  References

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/devel/CONTRIBUTING.html b/dev/devel/CONTRIBUTING.html index a8c268b453e..73730bd3ff9 100644 --- a/dev/devel/CONTRIBUTING.html +++ b/dev/devel/CONTRIBUTING.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -1019,7 +1019,7 @@

                  Further Reading

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/devel/index.html b/dev/devel/index.html index f0a6296e60e..5d04193326f 100644 --- a/dev/devel/index.html +++ b/dev/devel/index.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -630,7 +630,7 @@

                  Versions

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/devel/infrastructureguide.html b/dev/devel/infrastructureguide.html index eaa9a90a9aa..08ed2361442 100644 --- a/dev/devel/infrastructureguide.html +++ b/dev/devel/infrastructureguide.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -751,7 +751,7 @@

                  Conda#<

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/devel/roadmap.html b/dev/devel/roadmap.html index ef64391f3bb..6fc513d11b7 100644 --- a/dev/devel/roadmap.html +++ b/dev/devel/roadmap.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -767,7 +767,7 @@

                  Other Items

                  - Created using Sphinx 8.0.2. + Created using Sphinx 8.1.3.

                  diff --git a/dev/examples/Advanced_Sounding.html b/dev/examples/Advanced_Sounding.html index f697999da93..47ddea23125 100644 --- a/dev/examples/Advanced_Sounding.html +++ b/dev/examples/Advanced_Sounding.html @@ -43,7 +43,7 @@ - + @@ -75,7 +75,7 @@ - + @@ -680,7 +680,7 @@ plt.show() -Advanced Sounding

                  Total running time of the script: (0 minutes 0.172 seconds)

                  +Advanced Sounding

                  Total running time of the script: (0 minutes 0.165 seconds)

                  -Advanced Sounding With Complex Layout
                  [<matplotlib.lines.Line2D object at 0x7f9673482e50>]
+Advanced Sounding With Complex Layout
                  [<matplotlib.lines.Line2D object at 0x7f4d1a8b05d0>]
 
                  
 
                  
 
                  This layout isn’t bad, especially for how little code it requires,
@@ -929,7 +929,7 @@
 plt.show()
                  -Advanced Sounding With Complex Layout

                  Total running time of the script: (0 minutes 0.679 seconds)

                  +Advanced Sounding With Complex Layout

                  Total running time of the script: (0 minutes 0.639 seconds)

                  -28 February 2017 21:00Z, 300-hPa Wind Speeds and Heights, 500-hPa Absolute Vorticity and Heights, Surface Temperatures, Precipitable Water

                  Total running time of the script: (0 minutes 8.348 seconds)

                  +28 February 2017 21:00Z, 300-hPa Wind Speeds and Heights, 500-hPa Absolute Vorticity and Heights, Surface Temperatures, Precipitable Water

                  Total running time of the script: (0 minutes 8.162 seconds)

                  -

                  Total running time of the script: (0 minutes 8.942 seconds)

                  +

                  Total running time of the script: (0 minutes 8.768 seconds)

                  -

                  Total running time of the script: (0 minutes 0.138 seconds)

                  +

                  Total running time of the script: (0 minutes 0.133 seconds)

                  -

                  Total running time of the script: (0 minutes 0.114 seconds)

                  +

                  Total running time of the script: (0 minutes 0.110 seconds)

                  -

                  Total running time of the script: (0 minutes 0.122 seconds)

                  +

                  Total running time of the script: (0 minutes 0.116 seconds)

                  -Equivalent Potential Temperature (Kelvin)

                  Total running time of the script: (0 minutes 0.073 seconds)

                  +Equivalent Potential Temperature (Kelvin)

                  Total running time of the script: (0 minutes 0.070 seconds)