bump: v1.9.2

pysoer · Jan 9, 2025 · d3e8709 · d3e8709
1 parent bb57633
commit d3e8709
Show file tree

Hide file tree

Showing 31 changed files with 632 additions and 411 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,10 +1,20 @@
 module.exports = {
-	title: "PyCINRAD",
+	title: "PyCINRAD  官网",
 	description: "PyCINRAD官网首页 PyCINRAD文档",
+	lang: "zh-CN",
+	locales: {
+		"/": {
+			lang: "zh-CN",
+			title: "PyCINRAD  官网",
+			description: "PyCINRAD官网首页 PyCINRAD文档",
+		},
+	},
 	// 注入到当前页面的 HTML <head> 中的标签
 	head: [
 		["link", { rel: "icon", href: "/favicon.ico" }], // 增加一个自定义的 favicon(网页标签的图标)
 		["link", { rel: "stylesheet", href: "/css/index.css" }],
+		["script", { src: "/js/index.js" }],
+		["script", { src: "https://hm.baidu.com/hm.js?febea1f4b53924b48c8c661a05d8b63e" }],
 	],
 	base: "/", // 这是部署到github相关的配置 下面会讲
 	markdown: {
@@ -14,7 +24,7 @@ module.exports = {
 		logo: "/radar.png",
 		sidebarDepth: 2, // e'b将同时提取markdown中h2 和 h3 标题，显示在侧边栏上。
 		lastUpdated: "Last Updated", // 文档更新时间：每个文件git最后提交的时间
-        displayAllHeaders: true,
+		displayAllHeaders: true,
 		nav: [
 			{ text: "Home", link: "/" }, // 内部链接 以docs为根目录
 			{ text: "文档", link: "/install/" }, // 内部链接 以docs为根目录
@@ -29,11 +39,11 @@ module.exports = {
 				children: [
 					{
 						title: "安装",
-						path: "/install/安装&升级.md",
+						path: "/install/install.md",
 					},
 					{
-						title: "快速开始",
-						path: "/install/开始测试.md",
+						title: "引用导入",
+						path: "/install/startTest.md",
 					},
 				],
 			},
@@ -42,28 +52,36 @@ module.exports = {
 				path: "/io",
 				children: [
 					{
-						title: "标准格式基数据",
-						path: "/io/标准格式基数据.md",
+						title: "0.认识文件类型",
+						path: "/io/ftype.md",
+					},
+					{
+						title: "1.标准格式基数据",
+						path: "/io/StandardData.md",
 					},
 					{
-						title: "非标准格式基数据",
-						path: "/io/非标准格式基数据.md",
+						title: "2.非标准格式基数据",
+						path: "/io/CinradReader.md",
 					},
 					{
-						title: "相控阵雷达基数据",
-						path: "/io/相控阵雷达基数据.md",
+						title: "3.相控阵雷达基数据",
+						path: "/io/PhasedArrayData.md",
 					},
 					{
-						title: "标准格式产品rose2.0",
-						path: "/io/标准格式产品rose2.0.md",
+						title: "4.衍生产品计算",
+						path: "/io/calc.md",
 					},
 					{
-						title: "探测中心天气雷达拼图系统v3产品",
-						path: "/io/探测中心天气雷达拼图系统v3产品.md",
+						title: "5.标准格式产品rose2.0",
+						path: "/io/StandardPUP.md",
 					},
 					{
-						title: "swan3产品",
-						path: "/io/swan3产品.md",
+						title: "6.探测中心天气雷达拼图系统v3产品",
+						path: "/io/MocMosaic.md",
+					},
+					{
+						title: "7.swan3产品",
+						path: "/io/SWAN3.md",
 					},
 				],
 			},
@@ -73,24 +91,45 @@ module.exports = {
 				children: [
 					{
 						title: "画图",
-						path: "/visualize/画图.md",
+						path: "/visualize/PPI.md",
 					},
 					{
 						title: "雷达拼图",
-						path: "/visualize/雷达拼图.md",
+						path: "/visualize/GridMapper.md",
 					},
 				],
 			},
 			{
 				title: "其他",
 				path: "/other",
-				children:[
+				children: [
+					{
+						title: "Pyinstaller打包",
+						path: "/other/pyinstaller.md",
+					},
 					{
 						title: "修改基数据源文件",
 						path: "/other/editBfile.md",
-					}
-				]
-			}
+					},
+				],
+			},
 		],
+		repo: "pysoer/PyCINRADDoc",
+		// 自定义仓库链接文字。默认从 `themeConfig.repo` 中自动推断为
+		// "GitHub"/"GitLab"/"Bitbucket" 其中之一，或是 "Source"。
+		repoLabel: "文档源码",
+
+		// 以下为可选的编辑链接选项
+
+		// 假如你的文档仓库和项目本身不在一个仓库：
+		docsRepo: "pysoer/PyCINRADDoc",
+		// 假如文档不是放在仓库的根目录下：
+		docsDir: "docs",
+		// 假如文档放在一个特定的分支下：
+		docsBranch: "main",
+		// 默认是 false, 设置为 true 来启用
+		editLinks: true,
+		// 默认为 "Edit this page"
+		editLinkText: "帮助我们改善此页面！",
 	},
 };
diff --git a/docs/.vuepress/public/DancingScript-Bold.ttf b/docs/.vuepress/public/DancingScript-Bold.ttf
diff --git a/docs/.vuepress/public/blank.png b/docs/.vuepress/public/blank.png
diff --git a/docs/.vuepress/public/css/index.css b/docs/.vuepress/public/css/index.css
@@ -1,3 +1,18 @@
-#main-title{
-    margin-top: 180px;
+@font-face {
+	font-family: Dancing_Script;
+	src: url("../DancingScript-Bold.ttf");
+}
+
+#main-title {
+	margin-top: 1px;
+	font-family: Dancing_Script, "Rakkas", "Alegreya", "Lora";
+	font-size: 3em;
+	font-weight: bold;
+}
+
+.home .hero img {
+    max-width: 100%;
+    max-height: 155px;
+    display: block;
+    margin: 3rem auto 1.5rem;
 }
diff --git a/docs/.vuepress/public/js/index.js b/docs/.vuepress/public/js/index.js
@@ -0,0 +1,6 @@
+window.onload = function () {
+    var heroimg = document.querySelectorAll('.hero img');
+    if (heroimg.length !== 0) {
+        heroimg[0].style.maxHeight = '155px';
+    }    
+}
diff --git a/docs/.vuepress/public/radar.png b/docs/.vuepress/public/radar.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,16 +1,21 @@
 ---
 home: true
-# heroImage: /blank.png
+heroImage: /blank.png
 heroText: PyCINRAD
 tagline: 国内最强大的雷达数据处理工具
 actionText: 快速上手 →
 actionLink: /install/
+lang: zh-CN
 features:
 - title: 格式大师
-  details: 支持多种CINRAD雷达数据格式，兼容性强，横扫CMA雷达基数据和产品，国内首个支持“探测中心拼图3.0”。
+  details: 支持多种CINRAD雷达数据格式，兼容性强，横扫CMA雷达基数据和产品，国内率先支持“探测中心拼图3.0”。
 - title: 计算达人
   details: 快速提取、计算雷达衍生产品，如组合反射率CR、回波顶高ET、降水粒子分类HCL等。
 - title: 广为人知
   details: 作为一个开源项目，PyCINRAD对所有用户免费开放，鼓励社区贡献和改进。据悉已遍布CMA的各个系统角落。
-footer: MIT Licensed | Copyright © 2024-present CyanideCN & Pysoer.
----
+---
+
+
+::: slot footer
+MIT Licensed | Copyright © 2024-present CyanideCN & Pysoer. [湘ICP备2024085395号-2](https://beian.miit.gov.cn/#/Integrated/index)
+:::
diff --git a/docs/install/README.md b/docs/install/README.md
@@ -1,14 +1,14 @@
 # 简介
 `PyCINRAD`是一个专为解码和可视化中国新一代天气雷达（CINRAD）数据而设计的Python模块。它堪称气象数据领域的超级明星，为气象科研人员、天气预报员及气象爱好者提供了一个高效、便捷的雷达数据解决方案。
 
-* **数据支持全面** 无论是旧版本还是新标准的数据，PyCINRAD都能轻松应对。通过其强大的数据处理能力，用户可以快速提取所需信息，进行复合反射率、回波顶高、垂直积分液态含水量等多种雷达衍生产品的计算。此外，数据校正功能如速度退模糊等，确保了数据的准确性和可靠性。
+* **数据支持全面** 全面支持标准格式基数据（包括X波段相控阵）、ROSE2产品、探测中心拼图、SWAN产品等等。通过其强大的数据处理能力，用户可以快速提取所需信息，进行组合反射率、回波顶高、垂直积分液态含水量、降水粒子分类等多种雷达衍生产品的计算。此外还支持数据校正功能如速度退模糊等。
 
 * **出色的可视化** 支持PPI（平面位置显示）和Section（剖面）等多种可视化方式，用户可以自定义绘图参数，实现高度个性化的数据展示。这些功能使得气象数据的解读和分析变得更加直观和便捷。
 
 * **易于安装和使用** 它兼容Python 3.9及以上版本，支持通过pip快速安装。此外，丰富的文档和示例代码，以及活跃的开发者社区，使得用户在使用过程中能够获得及时的帮助和支持。
 
 * **永久开源** 作为一个开源项目，PyCINRAD对所有用户免费开放，鼓励社区贡献和改进。它的应用场景广泛，包括但不限于气象研究、天气预报、灾害预警以及教育培训等。无论是在学术研究还是实际应用中，PyCINRAD都展现出了其无与伦比的价值和潜力。
 
-PyCINRAD是一个功能全面、易于上手且高度可定制的气象雷达数据处理与可视化库。它让气象数据的处理和分析变得更加简单、高效和直观，是气象领域不可或缺的一款工具。    
+PyCINRAD是一个功能全面、易于上手且高度可定制的气象雷达数据处理与可视化库。让气象数据的处理和分析变得更加简单、高效和直观，是气象领域不可或缺的一款工具。    
 源码地址：[https://github.com/CyanideCN/PyCINRAD](https://github.com/CyanideCN/PyCINRAD)    
 QQ群：`480305660`
diff --git a/docs/install/install.md b/docs/install/install.md
@@ -0,0 +1,26 @@
+# 安装
+
+本文档运行的cinrad 版本为`v1.9.2`，Python 版本要求: `3.9+` 至于`cartopy`,`numpy`,`matplotlib`等库,安装最新版即可，`cartopy`版本>0.22。
+
+安装方法 ①：
+
+```python
+pip install cartopy matplotlib numpy -U
+pip install cinrad -U
+```
+
+网速慢的话，在上面命令后边加上 `-i https://pypi.tuna.tsinghua.edu.cn/simple`
+
+安装方法 ②：请先安装[git](https://blog.csdn.net/weixin_42242910/article/details/136297201)
+
+```bash
+D:                                         # 进入D盘,因为C盘权限会不够
+pip uninstall cinrad                       # 卸载当前版本
+git clone https://github.com/CyanideCN/PyCINRAD.git
+cd PyCINRAD
+python setup.py install
+```
+
+pip安装报错: Microsoft Visual C++ 14.0 or greater is required. Get it with “Microsoft C++ Build Tools“
+[https://blog.csdn.net/zymhhh/article/details/140642202](https://blog.csdn.net/zymhhh/article/details/140642202)
+参考这个方法，把右边那些该勾上的都勾上。特别是windows xx SDK
diff --git a/docs/install/startTest.md b/docs/install/startTest.md
@@ -0,0 +1,25 @@
+# 开始测试
+- 运行代码时，需要import导入cinrad，示例如下。
+- 说明：本文中的所有数据，雷达站所在的经纬度都作了**脱密，站号均改成了Z9999**，因此画图的位置是错的，请忽略。
+```python
+import cinrad
+import cartopy
+from cinrad.visualize import PPI
+import numpy as np
+import matplotlib.pyplot as plt
+import datetime
+%matplotlib inline  #这一句只在jupyter notebook中使用，在编辑器或命令行运行请删掉
+import warnings
+warnings.filterwarnings("ignore")
+
+# 这里是我测试的数据文件目录，请根据实际情况修改
+basePath = "d:/temp/" # 数据存放路径
+print(cinrad.__version__) # 打印cinrad版本
+print(np.__version__)   # 打印numpy版本
+print(cartopy.__version__)  # 打印cartopy版本
+```
+```md
+1.9.2
+2.0.2
+0.23.0
+```
diff --git a/docs/install/安装&升级.md b/docs/install/安装&升级.md
diff --git a/docs/install/开始测试.md b/docs/install/开始测试.md
diff --git a/docs/io/非标准格式基数据.md → docs/io/CinradReader.md b/docs/io/非标准格式基数据.md → docs/io/CinradReader.md
@@ -1,12 +1,11 @@
 # 非标准格式基数据
 SB/CC/CA等少部分数据最好是用CinradReader并手动输入参数radar_type
+`cinrad.io.CinradReader/read_auto`
 ```python
 nFiles = basePath + "/cinrad/bz2/Z_RADR_I_Z9636_20200625140000_O_DOR_SB_CAP.bz2"
-f = cinrad.io.read_auto(nFiles)
-# f = cinrad.io.CinradReader(nFiles, radar_type="SB")
+f = cinrad.io.CinradReader(nFiles, radar_type="SB")
 print(type(f).__name__)
 data = f.get_data(0, 230, "REF")
-
 data
 ```
 ```md
@@ -36,33 +35,33 @@ Attributes:
     task:             VCP21
 ```
 ```python
-f.el
+f.el # 仰角
 ```
 ```md
 array([ 0.49987793,  0.49987793,  1.44470215,  1.44470215,  2.39501953,
         3.34533691,  4.2956543 ,  5.99853516,  9.89868164, 14.59533691,
        19.49523926])
 ```
 ```python
-f.available_product(0)
+f.available_product(0) # 第1个仰角可用产品
 ```
 ```md
 ['REF', 'VEL', 'SW', 'azimuth', 'RF']
 ```
 ```python
-f.Rreso
+f.Rreso #分辨率
 ```
 ```md
 np.float64(1.0)
 ```
 ```python
-f.angleindex_r
+f.angleindex_r # 仰角索引
 ```
 ```md
 array([0, 2, 4, 5, 6, 7, 8, 9])
 ```
 ```python
-f.angleindex_v
+f.angleindex_v # 速度的仰角索引
 ```
 ```md
 array([1, 3, 4, 5, 6, 7, 8, 9])