Introduction to TC‑Python API

TC-Python is available with all operating systems supported by Thermo-Calc (Windows, Mac, and Linux) and examples are included with this API to help you learn about using the Python scripts as well as can be used as the basis for your own projects.

How TC-Python is connected to Thermo-Calc, the Python distributions and IDEs

Read more about TC-Python and its capabilities on our website. Scroll to the bottom of the page to access several resources such as videos, publications, blogs, documentation, and much more.

The design of the API (and using intelligent code completion with some IDEs such as Microsoft's Intellisense®) guides you through the process of setting up the simulation, where good default values are used. This minimizes the occurrence of errors and makes it an easy option even for those who do not have experience working with APIs.

An example of the PyCharm IDE with an example of using the intelligent code completion and its associated documentation that describes the classes and methods.

An example of the PyCharm IDE using the intelligent code completion and its associated documentation that describes the classes and methods.

Some key features of TC-Python include:

  • TC-Python is based on the Python™ programming language and uses intelligent code completion to help you more easily navigate through the available classes and methods.
  • Python™ is a widely used language in science community but is also used for web applications and other things. For someone experience or just starting out as a programmer.
  • This API is an integral part of the Integrated Computational Materials Engineering (ICME) framework, where you can couple it in a very open way. For example, you can use numerical packages like NumPy and SciPy in combination with our calculations as well as more easily do parallel computations.
  • As an object-oriented approach, this makes it easier to reuse information (classes/methods) and more quickly run your calculations when you need to change the compositions.
  • TC-Python can be used to develop custom Property Models for the Property Model Calculator. User developed Property Models allow you to customize Thermo-Calc to meet your modeling needs.

Examples

After you have installed all the necessary items to get up and running then you can look at several examples, which are included. You can use these examples to both learn about the use of TC-Python and as a way to build your own calculation project. See TC‑Python Examples.

The full documentation (see About the TC-Python Documentation) includes the API Reference as well as detailed information about the architecture and useful sections about Best Practices and Troubleshooting.