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.
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.
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.
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
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.
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.
Problems with Auto-Completion
A bug has been discovered that prevents the auto-completion feature from working with recent versions of Pycharm. Therefore, we recommend that users use PyCharm 2020.3.5 or earlier until the bug is fixed. We are working to fix this and hope to have a solution soon.
Contact Thermo-Calc Software for Support with TC-Python
To contact Thermo-Calc Software for support with TC-Python:
Follow the instructions above to run the diagnostic script.
Save the diagnostic script for your version of Thermo-Calc by right-licking on the link and selecting “Save link as” or similar.
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.