Welcome to SurfaceTopography’s documentation!

Read and analyze surface topographies with Python. This code implements basic classes for handling uniform and nonuniform surface topography data. It contains a rich set of import filters for experimental surface topography data. Surface topographies can be easily analyzed using standard (rms height, power spectrum, …) and some special purpose (autocorrelation function, variable bandwidth analysis, …) statistical techniques.

If you use this code, please cite:

• Jacobs, Junge, Pastewka, Surf. Topogr. Metrol. Prop. 1, 013001 (2017)

• Röttger el al., Surf. Topogr. Metrol. Prop. 10, 035032 (2022)

Notes

• Installation
  • Optional dependencies
  • Direct installation with pip
  • Installation: Common problems
  • Reporting installation problems
  • Installation from source directory
  • Singularity container
• Usage
  • Handling topographies
• Testing
• Contributing to SurfaceTopography
  • Development
  • Code style
  • Development branches
  • Commits
  • Authors
  • Writing tests
  • Compiling the documentation

Package Reference

• SurfaceTopography package
• SurfaceTopography.Container package
• SurfaceTopography.Generic package
• SurfaceTopography.IO package
• SurfaceTopography.Nonuniform package
• SurfaceTopography.Support package
• SurfaceTopography.Uniform package
• SurfaceTopography.Models package

Indices and tables

• Index

• Module Index

• Search Page