Do you want to understand what drives the temperature score of your portfolio to make better engagement and investment decisions?
Quickstart If you prefer to get up and running quickly, we’ve got a no-code and a Python option:
Quickstart |
If you are unsure whether the tool will be useful for your application and workflow, or you would first like to run some examples to get a better idea of how the tool works and what types of outputs it generates, the @TODO: add link offers a quick and no-code opportunity for such testing. The notebook combines text and code to provide a testing environment for your research, to give you an understanding for how the tool can help you analyze companies’ and portfolios’ temperature scores, to aid your engagement and investment decisions.
The notebook is loaded with example data, but you can also use your own data. For your first test, you can simply run the code cells one by one in the current sequence, to get an understanding of how it works. If you are not familiar with Notebooks, please refer to this introduction.
The following diagram provides an overview of the different parts of the full toolkit and their dependencies:
As shown above, the Python code forms the core codebase of the ITR tool. It is recommended to use the Python package if the user would like to integrate the tool in their own codebase. In turn, the second option is running the tool via the API if the user’s preference is to include the tool as a Microservice in their existing IT infrastructure in the cloud or on premise. The development project also included the creation of a simple user interface (UI), which can be used for easier user interaction in combination with the API.
The ITR tool enables two main ways of installing and/or running the tool:
- Users can integrate the Python package in their codebase. For more detailed and up-to-date information on how to run the tool via the Python package, please consult the ‘Getting Started Using Python’ section.
- The tool can be included as a Microservice (containerized REST API) in any IT infrastructure (in the cloud or on premise). For more detailed and up-to-date information on how to run the tool via the API, please consult the ‘Getting Started Using REST API’ section. Optionally, the API can be run with a frontend (UI). This simple user interface makes testing by non-technical users easier. For more detailed and up-to-date information on how to use the UI as a frontend to the API, please consult the ‘Getting Started Using REST API’ section.
Given the open source nature of the tool, the community is encouraged to make contributions (refer to Contributing section to further develop and/or update the codebase. Contributions can range from submitting a bug report, to submitting a new feature request, all the way to further enhancing the tool’s functionalities by contributing code.
.. toctree:: :maxdepth: 4 :caption: Contents: intro getting_started rest_api FunctionalOverview DataRequirements Legends contributing links terms