beautify pages

pysoer · Oct 29, 2024 · 67ad48d · 67ad48d
1 parent 2f2d111
commit 67ad48d
Show file tree

Hide file tree

Showing 14 changed files with 71 additions and 56 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,4 @@ dist
 docs/.vuepress/dist
 docs/.vuepress/.cache
 docs/.vuepress/.temp
-
+.temp
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,9 +1,10 @@
 module.exports = {
 	title: "PyCINRAD",
-	description: "PyCINRAD Home Page",
+	description: "PyCINRAD官网首页 PyCINRAD文档",
 	// 注入到当前页面的 HTML <head> 中的标签
 	head: [
 		["link", { rel: "icon", href: "/favicon.ico" }], // 增加一个自定义的 favicon(网页标签的图标)
+		["link", { rel: "stylesheet", href: "/css/index.css" }],
 	],
 	base: "/pycinrad/", // 这是部署到github相关的配置 下面会讲
 	markdown: {
@@ -16,9 +17,10 @@ module.exports = {
         displayAllHeaders: true,
 		nav: [
 			{ text: "Home", link: "/" }, // 内部链接 以docs为根目录
-			{ text: "文档", link: "/install" }, // 内部链接 以docs为根目录
+			{ text: "文档", link: "/install/" }, // 内部链接 以docs为根目录
 			{ text: "Github", link: "https://github.com/CyanideCN/PyCINRAD" }, // 内部链接 以docs为根目录
-			{ text: "Pysoer", link: "https://pysoer.cn/" }, // 外部链接
+			{ text: "Pysoer", link: "https://github.com/pysoer/" }, // 外部链接
+			{ text: "QQ群", link: "https://qm.qq.com/cgi-bin/qm/qr?k=39_2pSpPnQg24dovCAXxN0eMKmVR8aX4&jump_from=webapi&authKey=tvKFX6eekUrBDJ/oRczm7JXKKTnM1Yfk+D3C9H6wacwVV2uuJ92lZj6DrPG9uo3p" }, // 外部链接
 		],
 		sidebar: [
 			{
@@ -79,10 +81,16 @@ module.exports = {
 					},
 				],
 			},
-			// {
-			// 	title: "其他",
-			// 	path: "/others",
-			// },
+			{
+				title: "其他",
+				path: "/other",
+				children:[
+					{
+						title: "修改基数据源文件",
+						path: "/other/editBfile.md",
+					}
+				]
+			}
 		],
 	},
 };
diff --git a/docs/.vuepress/public/css/index.css b/docs/.vuepress/public/css/index.css
@@ -0,0 +1,3 @@
+#main-title{
+    margin-top: 180px;
+}
diff --git a/docs/.vuepress/public/favicon.ico b/docs/.vuepress/public/favicon.ico
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 ---
 home: true
-heroImage: /blank.png
+# heroImage: /blank.png
 heroText: PyCINRAD
 tagline: 国内最强大的雷达数据处理工具
 actionText: 快速上手 →
@@ -9,7 +9,7 @@ features:
 - title: 格式大师
   details: 支持多种CINRAD雷达数据格式，兼容性强，横扫CMA雷达基数据和产品，国内首个支持“探测中心拼图3.0”。
 - title: 计算达人
-  details: 快速提取、计算雷达衍生产品，如组合反射率等。
+  details: 快速提取、计算雷达衍生产品，如组合反射率CR、回波顶高ET、降水粒子分类HCL等。
 - title: 广为人知
   details: 作为一个开源项目，PyCINRAD对所有用户免费开放，鼓励社区贡献和改进。据悉已遍布CMA的各个系统角落。
 footer: MIT Licensed | Copyright © 2024-present CyanideCN & Pysoer.

diff --git a/docs/install/README.md b/docs/install/README.md
@@ -1,13 +1,14 @@
 # 简介
-PyCINRAD是一个专为解码和可视化中国新一代天气雷达（CINRAD）数据而设计的Python模块。它堪称气象数据领域的超级明星，为气象研究人员、天气预报员及气象爱好者提供了一个高效、便捷的解决方案。
+`PyCINRAD`是一个专为解码和可视化中国新一代天气雷达（CINRAD）数据而设计的Python模块。它堪称气象数据领域的超级明星，为气象科研人员、天气预报员及气象爱好者提供了一个高效、便捷的雷达数据解决方案。
 
-这个库支持多种CINRAD雷达数据格式的读取，无论是旧版本还是新标准的数据，PyCINRAD都能轻松应对。通过其强大的数据处理能力，用户可以快速提取所需信息，进行复合反射率、回波顶高、垂直积分液态含水量等多种雷达衍生产品的计算。此外，数据校正功能如速度退模糊等，确保了数据的准确性和可靠性。
+* **数据支持全面** 无论是旧版本还是新标准的数据，PyCINRAD都能轻松应对。通过其强大的数据处理能力，用户可以快速提取所需信息，进行复合反射率、回波顶高、垂直积分液态含水量等多种雷达衍生产品的计算。此外，数据校正功能如速度退模糊等，确保了数据的准确性和可靠性。
 
-PyCINRAD在数据可视化方面同样表现出色。它支持PPI（平面位置显示）和Section（剖面）等多种可视化方式，用户可以自定义绘图参数，实现高度个性化的数据展示。这些功能使得气象数据的解读和分析变得更加直观和便捷。
+* **出色的可视化** 支持PPI（平面位置显示）和Section（剖面）等多种可视化方式，用户可以自定义绘图参数，实现高度个性化的数据展示。这些功能使得气象数据的解读和分析变得更加直观和便捷。
 
-PyCINRAD不仅功能强大，而且易于安装和使用。它兼容Python 3.9及以上版本，支持通过pip快速安装。此外，丰富的文档和示例代码，以及活跃的开发者社区，使得用户在使用过程中能够获得及时的帮助和支持。
+* **易于安装和使用** 它兼容Python 3.9及以上版本，支持通过pip快速安装。此外，丰富的文档和示例代码，以及活跃的开发者社区，使得用户在使用过程中能够获得及时的帮助和支持。
 
-作为一个开源项目，PyCINRAD对所有用户免费开放，鼓励社区贡献和改进。它的应用场景广泛，包括但不限于气象研究、天气预报、灾害预警以及教育培训等。无论是在学术研究还是实际应用中，PyCINRAD都展现出了其无与伦比的价值和潜力。
+* **永久开源** 作为一个开源项目，PyCINRAD对所有用户免费开放，鼓励社区贡献和改进。它的应用场景广泛，包括但不限于气象研究、天气预报、灾害预警以及教育培训等。无论是在学术研究还是实际应用中，PyCINRAD都展现出了其无与伦比的价值和潜力。
 
-PyCINRAD是一个功能全面、易于上手且高度可定制的气象雷达数据处理与可视化库。它让气象数据的处理和分析变得更加简单、高效和直观，是气象领域不可或缺的一款工具。
-地址：`https://github.com/CyanideCN/PyCINRAD`
+PyCINRAD是一个功能全面、易于上手且高度可定制的气象雷达数据处理与可视化库。它让气象数据的处理和分析变得更加简单、高效和直观，是气象领域不可或缺的一款工具。    
+源码地址：[https://github.com/CyanideCN/PyCINRAD](https://github.com/CyanideCN/PyCINRAD)    
+QQ群：`480305660`
diff --git a/docs/install/安装&升级.md b/docs/install/安装&升级.md
@@ -1,20 +1,20 @@
 # 安装&升级
-Python版本要求: 3.9+    
-目前cinrad版本为v1.9.1
+Python版本要求: `3.9+` 至于`cartopy`,`numpy`,`matplotlib`等库,安装最新版即可。    
+目前cinrad版本为`v1.9.1`
 ```python
 pip install cartopy
 pip install cinrad -U
 ```
-网速慢的话，在上面命令后边加上 -i https://pypi.tuna.tsinghua.edu.cn/simple
+网速慢的话，在上面命令后边加上 `-i https://pypi.tuna.tsinghua.edu.cn/simple`
 ```python
 # 有很多朋友Windows下安装cartopy失败，建议安装anaconda来处理。
 conda install cartopy -c conda-forge
 # 同时需要安装 Visual studio 生成工具;
 # `https://blog.csdn.net/zymhhh/article/details/140642202`
 # 参考这个方法，把右边那些该勾上的都勾上。特别是windows xx SDK
 ```
-如果要以下新功能，则需要到github下载更新（请先安装git）    
--> 组合反射率拼图:在mergeCR分支
+如果要以下新功能，则需要到github下载分支进行更新（[请先安装git(安装教程)](https://blog.csdn.net/weixin_42242910/article/details/136297201)）    
+* 组合反射率拼图:在mergeCR分支
 ```bash
 pip install git+https://github.com/pysoer/PyCINRAD.git@mergeCR -U --force-reinstall --no-deps
-```
+```
diff --git a/docs/io/README.md b/docs/io/README.md
@@ -1,42 +1,41 @@
-# 支持的文件类型
-PyCINRAD支持读取以下文件类型，大部分可以从文件名中判断出来。
+# 数据读取
+PyCINRAD有以下读取接口,文件类型大部分可以从文件名中判断出来。
+```md  
+cinrad.io.StandardData    
+cinrad.io.StandardPUP    
+cinrad.io.MocMosaic    
+cinrad.io.SWAN(filename,product="CR")    
+cinrad.io.CinradReader(filename,radar_type="CC")        
+cinrad.io.PhasedArrayData    
+cinrad.io.PUP    
+cinrad.io.read_auto
+```
 #### 1. 标准格式基数据StandardData
 标准格式基数据: 标准格式文件名中有“FMT”、基数据是O_DOR
-Z_RADR_I_Z9999_20231025220414_O_DOR_SA_CAP_FMT.bin
+`Z_RADR_I_Z9999_20231025220414_O_DOR_SA_CAP_FMT.bin`
 #### 2. 标准格式产品StandardPUP
 标准格式产品: 标准格式文件名中有“FMT”、产品数据是P_DOR
   这里文件名中有HCL，代表是HCL水凝物分类产品
-Z_RADR_I_Z9999_20231231160439_P_DOR_SAD_HCL_250_230_5_FMT.bin
+`Z_RADR_I_Z9999_20231231160439_P_DOR_SAD_HCL_250_230_5_FMT.bin`
   下面这种老格式的也是标准格式产品
 Z9737_20231126150649Z_CR_00_37
 #### 3. 探测中心天气雷达拼图系统v3产品.MocMosaic
  ACHN表示是全网拼图，CREF表示是产品类型是CREF组合反射率
-Z_RADA_C_BABJ_20231212010615_P_DOR_ACHN_CREF_20231212_010000
+`Z_RADA_C_BABJ_20231212010615_P_DOR_ACHN_CREF_20231212_010000`
 #### 4. SWAN
  以前的老SWAN3产品.MCR表示拼图组合反射率
-Z_OTHE_RADAMCR_20220525085400.bin
+`Z_OTHE_RADAMCR_20220525085400.bin`
 #### 5. 老格式的国产基数据.CinradReader
  和标准格式的唯一区别是文件名中没有“FMT”（这里指的是大部分新情况）
-Z_RADR_I_Z9731_20240511070524_O_DOR_SAD_CAP.bin
+`Z_RADR_I_Z9731_20240511070524_O_DOR_SAD_CAP.bin`
 #### 6. 相控阵PhasedArrayData
 标准格式的相控阵雷达基数据(2023以后).
  文件名一般有AXPT，就是纳睿雷达的产品。
- Z_RADR_I_ZBJ02_20210815155836_O_DOR_DXK_CAR    
- Z_RADR_I_ZA601_20240415183600_O_DOR_AXPT0364_CRA_FMT    
- Z_RADR_I_ZS999_20231220000000_O_DOR_AXPT0364_CRA_.bz2    
+ `Z_RADR_I_ZBJ02_20210815155836_O_DOR_DXK_CAR`    
+ `Z_RADR_I_ZA601_20240415183600_O_DOR_AXPT0364_CRA_FMT`    
+ `Z_RADR_I_ZS999_20231220000000_O_DOR_AXPT0364_CRA_.bz2`    
 #### 7: PUP
 NEXRAD Level 3 (NIDS) product files.
 已经被淘汰的格式，一言难尽，格式太乱，能用则用吧。
 #### 万能读取read_auto
 如果你搞不清楚，那请用cinrad.io.read_auto(your_radar_file)来读取。
-#### 总结，有以下接口: 
-```md  
-cinrad.io.StandardData    
-cinrad.io.StandardPUP    
-cinrad.io.MocMosaic    
-cinrad.io.SWAN(filename,product="CR")    
-cinrad.io.CinradReader(filename,radar_type="CC")        
-cinrad.io.PhasedArrayData    
-cinrad.io.PUP    
-cinrad.io.read_auto
-```
diff --git a/docs/io/探测中心天气雷达拼图系统v3产品.md b/docs/io/探测中心天气雷达拼图系统v3产品.md
@@ -76,8 +76,8 @@ Attributes:
     scan_time:        2024-05-20 00:05:00
     site_code:        Z9734
     site_name:        衡阳g_Z9734
-    site_longitude:   112.5822
-    site_latitude:    26.935
+    site_longitude:   112.0
+    site_latitude:    26.0
     tangential_reso:  0.1
     range:            320
     elevation:        0
@@ -101,8 +101,8 @@ Attributes:
     scan_time:        2024-05-20 00:05:00
     site_code:        Z9734
     site_name:        衡阳g_Z9734
-    site_longitude:   112.5822
-    site_latitude:    26.935
+    site_longitude:   112.0
+    site_latitude:    26.0
     tangential_reso:  0.1
     range:            320
     elevation:        0
@@ -135,8 +135,8 @@ Attributes:
     scan_time:        2022-12-25 13:46:00
     site_code:        Z9859
     site_name:        兴义Z9859
-    site_longitude:   104.8969
-    site_latitude:    25.0883
+    site_longitude:   112.0
+    site_latitude:    25.0
     tangential_reso:  0.1
     range:            240
     elevation:        0

diff --git a/docs/io/标准格式基数据.md b/docs/io/标准格式基数据.md
@@ -1,4 +1,5 @@
 # 标准格式基数据
+这里支持的有：标准格式雷达、标准格式相控阵雷达基数据，两种数据一个接口。**PyCINRAD独有**
 ```python
 nFiles = basePath + "/cinrad/bz2/Z_RADR_I_Z9532_20200517124300_O_DOR_SAD_CAP_FMT.bin.bz2"
 f= cinrad.io.read_auto(nFiles)

diff --git a/docs/other/README.md b/docs/other/README.md
@@ -0,0 +1,3 @@
+# 番外篇
+## 基数据编辑
+修改标准格式基数据，替换里面的站名站号等基本信息
diff --git a/docs/others/README.md → docs/other/editBfile.md b/docs/others/README.md → docs/other/editBfile.md
@@ -1,6 +1,6 @@
-# 番外篇
-## 基数据编辑
-修改标准格式基数据，替换里面的站名站号等基本信息
+* 修改标准格式基数据，替换里面的站名站号等基本信息
+
+
 ```python
 import struct
 import bz2

diff --git a/docs/visualize/雷达拼图.md b/docs/visualize/雷达拼图.md
@@ -1,6 +1,6 @@
 # 雷达拼图
 ##  基本反射率拼图（老方法）
-其实所有单仰角的数据都可以拼
+效果比较差，可以淘汰了~
 ```python
 mergePath = "d:/temp/cinrad/cr/"
 file1 = mergePath + "Z_RADR_I_Z9730_20240526075538_O_DOR_SB_CAP_FMT.bin.bz2"
@@ -20,7 +20,7 @@ fig = cinrad.visualize.PPI(grid_br, style="black", add_city_names=True)
 ```
 ![An image](./image_16.png)
 ## 基本反射率拼图（新方法）
-此方法需要升级到github上的最新版本,理论上ZDR、KDP这些也可以拼图
+此方法需要升级到github上的分支版本,理论上ZDR、KDP这些也可以拼图，前提是`数据是取各层的最大值`。
 pip install git+https://github.com/pysoer/PyCINRAD.git@mergeCR -U --force-reinstall --no-deps
 ```python
 mergePath = "d:/temp/cinrad/cr/"

diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "description": "pycinrad docs",
   "main": "index.js",
   "scripts": {
-    "docs:dev": "vuepress dev docs",
+    "docs:dev": "vuepress dev docs  --temp .temp",
     "docs:build": "vuepress build docs"
   },
   "author": "pysoer",