一个Python3包来处理来自CRESIS雪地雷达系统的数据
pySnowRadar的Python项目详细描述
Pysnow雷达
一个Python3包来处理来自CRESIS雪地雷达系统的数据。在
源代码安装(PyPI和conda forge包即将推出)
安装并初始化conda:https://docs.conda.io/en/latest/miniconda.html
克隆此存储库,创建conda环境并安装pySnowRadar:
(base) $ git clone https://github.com/kingjml/pySnowRadar.git
(base) $ cd ./pySnowRadar
(base) $ conda env create -f exact_dev_env.yml
(base) $ conda activate py3-pySnowRadar
(py3-pySnowRadar) $ pip install .
使用
查看Jupyter笔记本的使用场景和代码片段示例:
- Batch-processing of multiple NSIDC L1b Deconvoluted SnowRadar products
- Layer retrieval test of AWI SnowRadar product
- Layer retrievel test of OIB SnowRadar product
pySnowRadar不验证界面或积雪深度估计值。强烈建议用户将输出与测量值或参考值进行比较,以量化误差。用户应考虑不确定性,包括但不限于表面粗糙度、盐度和旁瓣。在
作为参考,以下论文(不是详尽的列表)描述了与雪雷达数据处理有关的不确定性:Panzer et al. (2013),Newman et al. (2014),Webster et al. (2014),King et al. (2015),Kwok et al. (2017)
发展与贡献
以下说明适用于已克隆此存储库并希望修改pySnowRadar内部工作方式的用户。在
从本地克隆或分支内部,创建一个新分支,您的修改将驻留在其中:
^{pr2}$进行修改后,您可以通过在本地克隆中使用pip
重新安装pySnowRadar来测试更改:
# Make sure you're in the proper python environment!
(py3-pySnowRadar) $ pip install . --upgrade
当您对更改感到满意时,您可以将更改推送到github.com网站然后打开一个请求。有关拉取请求的详细信息,请咨询Github's Documentation
(可选)试运行
测试文件存储在tests
子目录下,需要pytest
和{
运行测试
(py3-pySnowRadar) $ pytest
运行测试并生成覆盖率报告
这些命令运行测试并为任何未测试的文件生成覆盖率报告,其中Missing
列表示仍需要测试的行号
(py3-pySnowRadar) $ coverage run -m pytest
(py3-pySnowRadar) $ coverage report # to display the coverage report within a terminal
有时,查看html化的覆盖率报告会更好,因此请使用以下命令:
(py3-pySnowRadar) $ coverage html
这将生成一个包含覆盖率报告的htmlcov
文件夹。在浏览器中打开htmlcov/index.html
,查看哪些代码需要测试覆盖。在
- 项目
标签: