This is a Python interface package for the CreaTec scanning probe microscope (STM). This package serves two main purposes:
This component includes a wrapper class (createc.CreatecWin32) that interfaces with the Createc STM software. This component offers enhanced access to all standard remote operations, with additional custom methods such as ramp_bias_mV and ramp_current_pA, which expand the capabilities beyond the default functions.
In addition to interfacing with the STM, Py-Createc offers a suite of classes that handle and analyze the data files (.dat, .vert, etc.) generated by the STM. These tools ensures efficient and effective management of STM data, including functionalities like image instance creation and more.
The online documentation can be found here.
The Createc controller interface requires Windows, the Createc vendor software,
and pywin32. The controller code was used successfully with the live vendor
system, but that integration was not re-tested while preparing this release
because the vendor system was no longer available.
Reading Createc data files is independent of the controller. The random and CPU modes of the oscilloscope example and the file-viewing portion of the map example can also run without the controller. Hardware-backed example modes and the map's STM controls remain Windows/vendor features.
This release supports Python 3.7 through 3.9. From the repository root, install the package with:
python -m pip install .Install optional example dependencies when needed:
python -m pip install ".[example_maps]"
python -m pip install ".[osc]"
python -m pip install ".[utility]"Interfacing with Createc STM
import createc
stm = createc.CreatecWin32()
stm.stmbeep() # Playing the testing beep sound on the STM constroller
stm.ramp_bias_mV(1000) # Ramping bias to 1V
Handling STM Data Files
Furthermore, several classes are available to to read .dat, .vert files etc.
For example, an image instance can be created by:
import createc
image_file = createc.DAT_IMG('path/to/filename.dat')
.
+-- createc # The main modules
| +-- Createc_pyCOM
| | +-- CreatecWin32 # The wrapper class that expands the scope of default Createc functions. The .ramp_bias_mV and .ramp_current_pA methods are in here
| |
| +-- Createc_pyFile # The unified Createc file classes
| +-- GENERIC_FILE # The parent file class
| | +-- DAT_IMG(GENERIC_FILE) # The child class for reading .dat files
| | +-- VERT_SPEC(GENERIC_FILE) # The child class for reading .vert files
| +-- GRID_SPEC # A standalone class for .gridspec files
|
+-- examples
| +-- map # An applet to map out a bunch of images according to their locations/angles, useful for offline images-viewing
| +-- osc # An applet to show real-time STM signals, the channels can be easily configured inside the script
| +-- utility # A helper applet for the STM operation, The .ramp_bias_mV and .ramp_current_pA methods are in here. (see screenshots below)
|
+-- tests
+-- doc
+-- LICENSE
+-- README
The examples folder contains offline visualization modes,
sample data, and scripts that communicate with the STM. It is available in the
GitHub repository, tagged source downloads, and Python source distribution. It
is not installed by the wheel.
From a repository checkout or extracted source distribution, install the optional dependencies for all three examples:
python -m pip install ".[osc,example_maps,utility]"This script displays streaming values in an oscilloscope format. With no
hardware option it shows random data, and --cpu shows local CPU usage. The
STM-backed --zi, --temperature, and --adc modes require Windows and the
running vendor software.
python examples/osc/oscilloscope.py
python examples/osc/oscilloscope.py --cpu(matplotlib is required for this applet.)
This helper applet facilitates piecing together images scanned at different
locations. File viewing is offline. Its Connect to STM and coordinate-control
features require Windows and the running vendor software.
python examples/map/map.pyWith this utility, changing STM parameters is simplified to a single click, thus enhancing user convenience and efficiency.
python examples/utility/stm_tool.py
