Getting Started Using Python

The most fundamental part of the project is the Python module, which takes care of all the heavy lifting. You can install it easily through PIP. There are a couple ways to get started using the module. The easiest option is to run our getting started notebook on Google Colab. Alternatively, you can also run the notebooks locally or start from scratch using the API reference.

Note

This page focuses on the Python module. The getting started documentation for the REST API can be found on its dedicated page. For a distinction between the different parts of the project, have a look at the homepage.

Google Colab

The easiest way to get started is by using the getting started notebook on Google Colab. It guides you through all the steps involved in installing the module and consequently running it, i.e. calculating a temperature scores and analyzing portfolios. There are five notebooks that go through the process step-by-step:

We recommend that you start with notebook 1 analysis example, especially if you are new to Python and/or the temperature scoring methodology.

  1. Analysis example (with abbreviated methodology)

  2. Quick temperature calculation

  3. What-if analysis

  4. Portfolio aggregation

  5. Reporting

Jupyter Notebooks

Alternatively, you can also run the notebooks locally. To do so, you first need to set-up a new environment. In this example, we assume you use Anaconda to manage your environments. To do this, run the following command:

cd examples conda env create -f environment.yml activate sbti_getting_started jupyter notebook

A tab should now open in your web browser. If you are using a virtual environment, you can install the required packages using the requirements.txt file in the examples directory. Make sure that your Python version is at least 3.7.

Python code

If you are starting from scratch, you can install the latest version of the package directly from Github as follows:

pip install git+git://github.com/OFBDABV/SBTi

Or you can install the latest stable release from PyPi

pip install sbti

The API reference should provide a clear overview of the module’s API and its usage.