TC-Python Help

TC-Python API Reference Documentation

TC-Python is a Python™ language-based SDK available with Thermo-Calc that allows users to openly couple Thermo-Calc calculations with other software. To learn more about the features of this powerful API, visit our TC-Python page.

Current Documentation

TC-Python has its own documentation that is generated directly from the program. Two identical versions of the help are available: an HTML-based, online help system and PDF document.

Current Examples

Over 40 examples are available to help you get started using TC-Python. These examples can only be run if you have a current license for TC-Python and the relevant databases and modules.

Download the examples as a zip file

Version Specific Documentation

You can access TC-Python documentation for whatever version of the software you are running from within Thermo-Calc.

Open the version of Thermo-Calc where you want to view the documentation. From the main menu, click Help > Manuals Folder and then either navigate to the:

• TC-Python folder and click on the Index.html file to open the HTML version or
• SDK folder to open a PDF of the same documentation.

Archived PDFs

Previous versions of the TC-Python API Programmer Guide PDF are available from the Documentation archive and stored by software release year and version.  There are also zip files of the examples available in these release specific folders.

Troubleshooting and Diagnostics

Troubleshooting Guide

TC-Python comes with a troubleshooting guide to help you with common problems in the software. The guide is included in the documentation, and users should refer to the guide for the version of the software you use. For older versions of the software, see above for links to the documentation.

TC-Python Troubleshooting Guide

Diagnostic Script

There is also a diagnostic script to help you diagnose your problem, or that you can send to us if you need to contact us for support.

Click here and then select the diagnostic script for your version of Thermo-Calc

It is important to run the diagnostic script EXACTLY the same way as you run your TC-Python script (in the same IDE, same project, same Python environment, same Jupyter notebook, etc).

The script automatically prints useful suggestions that, in many cases, will help you to fix the problem yourself. If you are unable to solve the problem, contact us for support.

Contact Thermo-Calc Software for Support with TC-Python

To contact Thermo-Calc Software for support with TC-Python:

1. Follow the instructions above to run the diagnostic script.
2. Save the diagnostic script for your version of Thermo-Calc by right-licking on the link and selecting “Save link as” or similar.
3. Read the instructions on our Request Support page and paste the results of the diagnostic script into the email you send us. This will help us to provide faster, more accurate support.