访问http://getting-started.sbti-tool.org/获取完整文档

如有任何额外问题或评论，请发送邮件至：finance@sciencebasedtargets.org

SBTi 温度对齐工具

本包帮助公司和金融机构评估当前目标、承诺以及投资和贷款组合的温度对齐情况，并使用此信息开发由 SBTi 官方验证的目标。

该工具可以作为独立的 Python 包、REST API 或简单 Web 应用程序使用，后者提供 API 的简单界面。因此，SBTi 工具包适用于三种使用方式。

• 用户可以将 Python 包集成到他们的代码库中。
• 该工具可以作为微服务（容器化的 REST API）集成到任何 IT 基础设施中（在云端或本地）。
• 作为 Web 应用程序，通过简单的用户界面暴露功能。

以下图表提供了工具包不同部分的概述。

+-------------------------------------------------+
|   UI     : Simple user interface on top of API  |
|   Install: via dockerhub                        |
|            docker.io/sbti/ui:latest             |
|                                                 |
| +-----------------------------------------+     |
| | REST API: Dockerized FastAPI/NGINX      |     |
| | Source : github.com/OFBDABV/SBTi_api    |     |
| | Install: via source or dockerhub        |     |
| |          docker.io/sbti/sbti/api:latest |     |
| |                                         |     |
| | +---------------------------------+     |     |
| | |                                 |     |     |
| | |Core   : Python Module           |     |     |
| | |Source : github.com/OFBDABV/SBTi |     |     |
| | |Install: via source or PyPi      |     |     |
| | |                                 |     |     |
| | +---------------------------------+     |     |
| +-----------------------------------------+     |
+-------------------------------------------------+

如上图所示，API 依赖于 Python 仓库，同样 UI 需要 API 后端。这些依赖关系在 Docker 文件中进行了脚本化。

此存储库仅包含 Python 模块。如果您想使用 REST API，请参阅此存储库或 Dockerhub 上的同一存储库。

结构

此项目的文件夹结构如下

.
├── .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
├── SBTi                    # The main Python package for the temperature alignment tool
└── test                    # Automated unit tests for the SBTi package (Nose2 tests)

安装

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

pip install -e .

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

pip install sbti

开发

为开发目的，请使用以下命令安装 SBTi 包

pip install -e .[dev]

测试

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

nose2 -v