SBTi Temperature Alignment tool

Helps companies and financial institutions to assess the temperature alignment of current targets, commitments, and investment and lending portfolios, and to use this information to develop targets for official validation.
https://github.com/ScienceBasedTargets/SBTi-finance-tool

Category: Sustainable Development
Sub Category: Sustainable Investment

Keywords

climate-data climate-model climate-science finance portfolio suistainable

Keywords from Contributors

climate-data-analysis transforms archiving measur generic animals conversion observation optimize compose

Last synced: about 21 hours ago
JSON representation

Repository metadata

This toolkit helps companies and financial institutions to assess the temperature alignment of current targets, commitments, and investment and lending portfolios, and to use this information to develop targets for official validation by the SBTi. See the wiki for a change log.

Host: GitHub
URL: https://github.com/ScienceBasedTargets/SBTi-finance-tool
Owner: ScienceBasedTargets
License: mit
Created: 2020-05-25T11:19:22.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2025-03-24T21:27:29.000Z (about 1 month ago)
Last Synced: 2025-04-25T14:07:44.515Z (3 days ago)
Topics: climate-data, climate-model, climate-science, finance, portfolio, suistainable
Language: Python
Homepage: https://sciencebasedtargets.org/
Size: 31.9 MB
Stars: 53
Watchers: 8
Forks: 42
Open Issues: 25
Releases: 15
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

README.md

Visit https://sciencebasedtargets.github.io/SBTi-finance-tool/ for the full documentation

If you have any additional questions or comments send a mail to: [email protected]

SBTi Temperature Alignment tool

This package helps companies and financial institutions to assess the temperature alignment of current
targets, commitments, and investment and lending portfolios, and to use this information to develop
targets for official validation by the SBTi.

This tool can be used either as a standalone Python package, a REST API or as a simple webapp which provides a simple skin on the API.
So, the SBTi toolkit caters for three types of usage:

Users can integrate the Python package in their codebase
The tool can be included as a Microservice (containerised REST API) in any IT infrastructure (in the cloud or on premise)
As an webapp, exposing the functionality with a simple user interface.

To following diagram provides an overview of the different parts of the toolkit:

+-------------------------------------------------+
|   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/ScienceBasedTargets/     |
| | |               SBTi-finance-tool |     |     |
| | |Install: via source or PyPi      |     |     |
| | |                                 |     |     |
| | +---------------------------------+     |     |
| +-----------------------------------------+     |
+-------------------------------------------------+

As shown above the API is dependent on the Python Repo, in the same way the UI requires the API backend. These dependencies are scripted in the Docker files.

This repository only contains the Python module. If you'd like to use the REST API, please refer to this repository or the same repository on Dockerhub.

Structure

The folder structure for this project is as follows:

.
├── .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)

Installation

The SBTi package may be installed using PIP. If you'd like to install it locally use the following command. For testing or production please see the deployment section for further instructions

pip install -e .

For installing the latest stable release in PyPi run:

pip install sbti-finance-tool

Development

To set up the local dev environment with all dependencies, install poetry and run

poetry install

This will create a virtual environment inside the project folder under .venv.

Testing

Each class should be unit tested. The unit tests are written using the Nose2 framework.
The setup.py script should have already installed Nose2, so now you may run the tests as follows:

nose2 -v

Publish to PyPi

The package should be published to PyPi when any changes to main are merged.

Update package

bump version in pyproject.toml based on semantic versioning principles
run poetry build
run poetry publish
check whether package has been successfully uploaded

Initial Setup

Create account on PyPi

Owner metadata

Name: Science Based Targets initiative
Login: ScienceBasedTargets
Email:
Kind: organization
Description:
Website: https://sciencebasedtargets.org/
Location:
Twitter: sciencetargets
Company:
Icon url: https://avatars.githubusercontent.com/u/92389205?v=4
Repositories: 3
Last ynced at: 2024-04-20T20:52:00.206Z
Profile URL: https://github.com/ScienceBasedTargets

GitHub Events

Total

Issues event: 2
Watch event: 3
Delete event: 1
Issue comment event: 2
Push event: 6
Pull request event: 2
Create event: 2

Last Year

Issues event: 2
Watch event: 3
Delete event: 1
Issue comment event: 2
Push event: 6
Pull request event: 2
Create event: 2

Committers metadata

Last synced: 8 days ago

Total Commits: 676
Total Committers: 18
Avg Commits per committer: 37.556
Development Distribution Score (DDS): 0.675

Commits in past year: 7
Committers in past year: 1
Avg Commits per committer in past year: 7.0
Development Distribution Score (DDS) in past year: 0.0

Name	Email	Commits
OFJanPostema	j**a@o**m	220
David Kroon	d**n@o**m	144
VitoMurillo	A**o@o**m	90
Joris Cramwinckel	j**l@o**m	61
LEDdeBruijn	l**n@o**m	47
Daan van de Meeberg	d**g@o**m	29
Peter Nystroem	4****r	23
dependabot[bot]	4****]	12
Christian Schmidli	c**i@g**m	10
David Kroon	3****0	9
MikeM	M**s@O**m	9
hbsbti	h**l@s**g	7
Christian Schmidli	c**i@k**m	7
max-tikehaucapital	1****l	2
Daniel	3****I	2
Joris Cramwinckel	j**1@h**m	2
Piotr Jankowski	p**s@g**m	1
aleks-sch	1****h	1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 161
Total pull requests: 170
Average time to close issues: 26 days
Average time to close pull requests: 9 days
Total issue authors: 21
Total pull request authors: 16
Average comments per issue: 0.27
Average comments per pull request: 0.24
Merged pull request: 143
Bot issues: 0
Bot pull requests: 24

Past year issues: 2
Past year pull requests: 9
Past year average time to close issues: 2 days
Past year average time to close pull requests: less than a minute
Past year issue authors: 2
Past year pull request authors: 2
Past year average comments per issue: 1.0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 8

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ScienceBasedTargets/SBTi-finance-tool

Top Issue Authors

DaanvdMeeberg (95)
ofjpostema (22)
cschmidli (11)
joriscram (10)
LEDdeBruijn (5)
aleks-sch (2)
pjankows (2)
mountainrambler (1)
VerdureClimateLtd (1)
ogibbo (1)
JohnAdders (1)
lukasdenkstatt (1)
trev0rwright (1)
babetsdasha (1)
brookeann2015 (1)

Top Pull Request Authors

ofjpostema (44)
dependabot[bot] (24)
dp90 (21)
LEDdeBruijn (20)
mountainrambler (18)
joriscram (14)
cschmidli (10)
max-tikehaucapital (4)
VitoMurillo (4)
aleks-sch (2)
DaanvdMeeberg (2)
Warkanlock (2)
Waterstraal (2)
w0rdsm1th (1)
hbsbti (1)

Top Issue Labels

bug (13)
documentation (1)

Top Pull Request Labels

dependencies (25)
enhancement (1)

Package metadata

Total packages: 1
Total downloads:
- pypi: 427 last-month
Total dependent packages: 0
Total dependent repositories: 1
Total versions: 10
Total maintainers: 2

pypi.org: sbti-finance-tool

This package helps companies and financial institutions to assess the temperature alignment of current targets, commitments, and investment and lending portfolios, and to use this information to develop targets for official validation by the SBTi.'

Homepage:
Documentation: https://sciencebasedtargets.github.io/SBTi-finance-tool
Licenses: MIT
Latest release: 1.0.9 (published over 1 year ago)
Last Synced: 2025-04-26T14:37:06.813Z (2 days ago)
Versions: 10
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 427 Last month
Rankings:
- Forks count: 6.378%
- Stargazers count: 9.818%
- Dependent packages count: 10.126%
- Average: 12.318%
- Downloads: 13.732%
- Dependent repos count: 21.535%
Maintainers (2)
- cschmidli
- mountainrambler

Dependencies

examples/requirements.txt pypi

jupyter ==1.0.0
matplotlib ==3.2.2
openpyxl ==2.5.9
pandas ==1.0.3
requests *

poetry.lock pypi

alabaster 0.7.12 develop
appnope 0.1.3 develop
argcomplete 2.0.0 develop
astroid 2.11.7 develop
babel 2.10.3 develop
backcall 0.2.0 develop
black 21.10b0 develop
cffi 1.15.1 develop
click 8.1.3 develop
colorama 0.4.5 develop
debugpy 1.6.2 develop
decorator 5.1.1 develop
dill 0.3.5.1 develop
docutils 0.17.1 develop
entrypoints 0.4 develop
imagesize 1.4.1 develop
importlib-metadata 4.12.0 develop
ipykernel 6.5.0 develop
ipython 7.34.0 develop
isort 4.3.21 develop
jedi 0.18.1 develop
jinja2 3.1.2 develop
jupyter-client 7.3.4 develop
jupyter-core 4.11.1 develop
lazy-object-proxy 1.7.1 develop
markupsafe 2.1.1 develop
matplotlib-inline 0.1.3 develop
mccabe 0.7.0 develop
mypy-extensions 0.4.3 develop
nest-asyncio 1.5.5 develop
packaging 21.3 develop
parso 0.8.3 develop
pathspec 0.9.0 develop
pexpect 4.8.0 develop
pickleshare 0.7.5 develop
platformdirs 2.5.2 develop
prompt-toolkit 3.0.30 develop
ptyprocess 0.7.0 develop
py 1.11.0 develop
pycparser 2.21 develop
pygments 2.12.0 develop
pylint 2.13.9 develop
pyparsing 3.0.9 develop
pywin32 304 develop
pyyaml 6.0 develop
pyzmq 23.2.0 develop
regex 2022.7.9 develop
snowballstemmer 2.2.0 develop
sphinx 4.3.2 develop
sphinx-autoapi 1.8.4 develop
sphinx-rtd-theme 1.0.0 develop
sphinxcontrib-applehelp 1.0.2 develop
sphinxcontrib-devhelp 1.0.2 develop
sphinxcontrib-htmlhelp 2.0.0 develop
sphinxcontrib-jsmath 1.0.1 develop
sphinxcontrib-qthelp 1.0.3 develop
sphinxcontrib-serializinghtml 1.1.5 develop
tomli 1.2.3 develop
tornado 6.2 develop
traitlets 5.3.0 develop
typed-ast 1.5.4 develop
unidecode 1.3.4 develop
wcwidth 0.2.5 develop
wrapt 1.14.1 develop
zipp 3.8.1 develop
certifi 2022.6.15
charset-normalizer 2.1.0
et-xmlfile 1.1.0
idna 2.10
numpy 1.22.0
openpyxl 3.0.9
pandas 1.3.4
pydantic 1.8.2
python-dateutil 2.8.2
pytz 2022.1
requests 2.28.1
six 1.15.0
typing-extensions 4.3.0
urllib3 1.26.10
xlrd 1.2.0

pyproject.toml pypi

Sphinx 4.3.2 develop
black 21.10b0 develop
ipykernel 6.5.0 develop
pylint ^2.10.2 develop
sphinx-autoapi 1.8.4 develop
sphinx-rtd-theme 1.0.0 develop
openpyxl 3.0.9
pandas 1.3.4
pydantic 1.8.2
python >=3.7.1,<4
requests 2.28.1
six 1.15.0
xlrd 1.2.0

requirements.txt pypi

certifi ==2021.10.8
charset-normalizer ==2.0.12
et-xmlfile ==1.1.0
idna ==3.3
numpy ==1.22.0
openpyxl ==3.0.9
pandas ==1.3.4
pydantic ==1.8.2
python-dateutil ==2.8.2
pytz ==2021.3
requests ==2.23.0
six ==1.15.0
typing-extensions ==4.1.1
urllib3 ==1.22
xlrd ==1.2.0

setup.py pypi

openpyxl ==3.0.9
pandas ==1.3.4
pydantic ==1.8.2
requests ==2.28.1
six ==1.15.0
xlrd ==1.2.0

.github/workflows/docs2pages.yaml actions

JamesIves/github-pages-deploy-action 4.1.4 composite
actions/checkout v2 composite
actions/setup-python v2 composite
snok/install-poetry v1 composite

.github/workflows/notebooks.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
treebeardtech/treebeard master composite

.github/workflows/ossaudit.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

examples/environment.yml pypi

Score: 13.310865793273365

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

SBTi Temperature Alignment tool

Keywords

Keywords from Contributors

Repository metadata

README.md

SBTi Temperature Alignment tool

Structure

Installation

Development

Testing

Publish to PyPi

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

pypi.org: sbti-finance-tool

Dependencies