Examples

First Steps

Once py4DSTEM has been succsesfully installed, you can start using it in Python the usual way. The most popular way is using Jupyter Notebooks, but py4DSTEM can be run in python scripts, iPython, spyder, etc.

Your first py4DSTEM script

# Import the needed packages
import py4DSTEM

# This line displays the current version of py4DSTEM:
py4DSTEM.__version__

# download the dataset
py4DSTEM.io.download_file_from_google_drive(
    '1PmbCYosA1eYydWmmZebvf6uon9k_5g_S',
    'simulatedAuNanoplatelet_binned.h5'
)
file_data = "simulatedAuNanoplatelet_binned.h5"

# Load the data
datacube = py4DSTEM.io.read(
    file_data,
    data_id = 'polyAu_4DSTEM'     # The file above has several blocks of data inside
)

# plot a diffraction pattern
py4DSTEM.show(
    datacube[10,30],
    intensity_range='absolute',
    vmin=20,
    vmax=200,
    cmap='viridis',
)

Congratulations you’ve just plotted your first diffraction pattern.

If you run into trouble, refer back to the installation instructions Installation. Remember to make sure you’ve activated the right Python environment.

Next Steps

For a more extensive overview checkout the tutorial github repository to see example notebooks demonstraing the features of py4DSTEM. These can be downloaded and run locally or run through the browser using binder. Here are some example plots from different anaylses you’ll learn running the tutorials.