Getting started with TM1py

TM1py is a free Python package that wraps the TM1 REST API in a simple to use library. Making it easier to integrate systems more effectively with IBM Planning Analytics.

Why you should use it?

  • Load FX rates from web services such as FRED into the TM1 Server.
  • Greater automation of your forecast models with Pandas for Data Analysis and Statistics.
  • Advanced integration with machine learning and forecasting algorithms with Python, scikit-learn and the TM1 Server.

Getting Started!

TM1py is really quick and easy to setup, just follow these steps and you will be able to run your first Python script in less than 5 min!

1. Install TM1py

The first step is to install Python and TM1py. These steps are explained on the TM1py-samples github page.

2. Enable the TM1 REST API

TM1py uses the TM1 REST API to connect to the TM1 Server, you will need to enable the TM1 REST API on each instance where you want TM1py to connect to.

3. Download TM1py samples

TM1py includes a lot of ready to use samples that you can download on Github.

4. Run your first Python script

Ever wondered which of the dimensions in your TM1 instance are not used in cubes? TM1py can help to answer this questions with 8 Lines of code! Just follow these steps to know which dimensions are not used in your TM1 application.

5. Learn More