ITR-tool

基于CDP-WWF气温评级方法的SBTi-Finance-tool的WWF版本

有关完整文档，请访问https://wwf-sweden.github.io/ITR-tool/

如果您有任何其他问题或评论，请发送邮件至：ekonomi-finans@wwf.se

关于工具

本软件包帮助企业金融机构评估当前目标、承诺和投资贷款组合的气温一致性，并利用这些信息为SBTi官方验证的目标制定。

WWF金融工具箱可以以不同的方式使用

• 用户可以将Python软件包集成到他们的代码库中
• 使用笔记本，无论是在本地还是在Google Colab上

结构

本项目的文件夹结构如下

.
├── .github                 # Github specific files (Github Actions workflows)
├── app                     # FastAPI app files for the API endpoints
├── docs                    # Documentation files (Sphinx)
├── config                  # Config files for the Docker container
├── ITR                     # The main Python package for the temperature alignment tool
└── test                    # Automated unit tests for the SBTi package (Nose2 tests)

安装

SBTi软件包可以通过PIP安装。如果您想本地安装，请使用以下命令。有关测试或生产的进一步说明，请参阅部署部分。

pip install -e .

要在 PyPi 中安装最新稳定版，请运行

pip install wwf-itr

开发

为了设置带有所有依赖项的本地开发环境，请安装 poetry并运行

poetry install

这将在项目文件夹下的 .venv 中创建一个虚拟环境。

测试

每个类都应该进行单元测试。单元测试使用 Nose2 框架编写。setup.py 脚本应该已经安装了 Nose2，现在您可以按以下方式运行测试

nose2 -v

发布到 PyPi

当主分支有任何更改合并时，应该将包发布到 PyPi。

更新包

1. 根据语义版本化原则在 pyproject.toml 中升级版本
2. 运行 poetry build
3. 运行 poetry publish
4. 检查包是否已成功上传

初始设置

• 在 PyPi 上创建账户