跳转到主要内容

生物量产品算法实验室

项目描述

BIOPAL

Documentation Status PyPI PyPI - License PyPI - Python Version

BIOMASS产品算法实验室(BioPAL)是处理和分析欧洲航天局(ESA)BIOMASS任务数据的官方工具。

目标

BIOMASS是欧洲航天局(ESA)的第七个地球探索任务,目前计划于2023年发射。卫星将是太空中的第一个P波段合成孔径雷达(SAR)传感器,并将以全极化干涉和层析成像模式运行。任务的主要目标是绘制全球森林属性,但传感器也将允许探索地下场景(冰,沙漠)。

BIOMASS产品算法实验室(BioPAL)是针对BIOMASS原型处理器开发的软件的演变,成为一个开源库,供科学界使用和贡献。

此存储库收集了处理第1级SAR产品以生成第2级地上生物量(AGB)、森林高度(FH)和森林干扰(FD)森林产品的软件例程。关于这些产品和BIOMASS的更多详细信息,请在此处找到。

项目结构

此存储库组织如下

  • arepytools:Aresys I/O库,用于读取和管理输入数据集。未来将变为独立的库。

  • biopal:包含特定的BioPAL源代码。

    • biopal/_package_data文件夹(请勿编辑)包含默认的输入和配置xml文件(使用biopal-quickstart获取可编辑的版本,见下文入门部分)
  • doc:包含文档。

BioPAL已被一些ESA资助的项目使用,但它仍然是一个实验性代码。这意味着可能仍然存在错误。如果您偶然发现一个错误,请通过填写尽可能详细的问题报告来让我们高兴。

您可以通过以下链接查看版本1.0.0的开发路线图:这里

入门

有关高级安装和使用选项,请参阅下文的文档部分。

BioPAL安装(默认选项)

此安装程序使用开源软件包管理系统conda,需要预先安装。

打开一个带有conda的命令窗口,并按照以下步骤操作。

创建一个空的biopal环境

conda create --name biopal python=3.9

安装GDAL库

conda activate biopal
conda install -c conda-forge GDAL=3.5

安装软件包

pip install biopal

配置biopal

biopal-quickstart FOLDER

"FOLDER"是生成可用的和可编辑的Input_File.xmlConfiguration_File.xml文件的路径。

运行BioPAL

准备好您的Input_File.xmlConfiguration_File.xml,然后打开一个带有conda的命令窗口并运行BioPAL

conda activate biopal
biopal --conf conf_folder inputfilexml
  • inputfilexmlInput_File.xml的路径
  • conf_folder:包含Configuration_File.xml的文件夹的路径

BioPAL数据集

BioPAL提供了对几个数据集的便捷访问,这些数据集用于文档和测试中的示例。这些数据集托管在我们的FTP服务器上,必须下载才能使用。

请联系biopal@esa.int以获取数据集访问权限和更多信息。

贡献呼吁

BioPAL是一个开源项目,得到了一个欣赏来自不同背景的帮助的社区的支持。无论大小,任何贡献都会产生重大影响;如果您以前从未为开源项目做出过贡献,我们希望您从BioPAL开始!

如果您有兴趣做出贡献,请查看我们的贡献者指南。除了增强处理算法之外,还有许多其他方式可以做出贡献

  • 在GitHub Issues上提交错误报告或功能请求。
  • 向我们示例画廊贡献一个Jupyter笔记本。
  • 协助我们进行用户测试。
  • 增加文档或帮助我们的网站。
  • 为我们项目编写单元或集成测试。
  • 在我们的问题、Slack频道、MAAP论坛和其他地方回答问题。
  • 撰写博客文章、推文或与他人分享我们的项目。
  • 教某人如何使用BioPAL。

如您所见,有无数种方式参与其中,我们非常高兴您能加入我们!我们唯一的要求是,您遵守我们行为准则中描述的开放性、尊重和对他人的考虑。

简要贡献指南

在开始之前,请仔细阅读贡献者指南。

  1. 对存储库进行分叉。

  2. 在本地的私有分叉中克隆(在您的终端中执行以下命令)

    git clone https://github.com/your_name_here/BioPAL.git
    
  3. 按照文档中指定的说明操作,进行演示运行并与参考输出进行比较。确保所有测试都通过。

  4. 将主存储库添加到您的远程列表中(在本地更改之前拉取最新的更改)

    git remote add upstream https://github.com/BioPAL/BioPAL
    
  5. 为本地开发创建一个分支。

  6. 提交本地更改并将本地分支推送到GitHub私有分叉。

  7. 通过GitHub网站向主存储库的主分支提交一个拉取请求。

拉取请求要求

  1. 包括所有新开发的例程的新测试。
  2. 文档应根据需要进行更新。
  3. 更新的代码必须通过所有测试。

文档

文档正在编写中,可在项目doc/文件夹网站doc部分找到。

先前原型软件的用户手册可在遗留部分找到。

历史

BioPAL最初由Aresys编写,并由ESA代表BioPAL团队维护。

BioPAL团队包括几个欧洲研究机构的代表,请参阅网站关于部分

引用

如果您使用BioPAL,请添加以下引用

  • BioPAL: BIOMASS产品算法实验室,https://github.com/BioPAL/BioPAL

  • Banda F, Giudici D, Le Toan T, Mariotti d’Alessandro M, Papathanassiou K, Quegan S, Riembauer G, Scipal K, Soja M, Tebaldini S, Ulander L, Villard L. BIOMASS第二级原型处理器的设计及地面生物量估算的实验结果。遥感。2020;12(6):985. https://doi.org/10.3390/rs12060985

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

biopal-0.4.0rc0.tar.gz (256.1 kB 查看哈希值)

上传时间

构建分布

biopal-0.4.0rc0-py3-none-any.whl (277.7 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面