Read and analyze surface topographies
Project description
SurfaceTopography
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)
Build status
The following badge should say tests passing. This means that all automated tests completed successfully for the master branch.
Documentation
This README file contains a brief introduction into the code. The full documentation can be found at https://contactengineering.github.io/SurfaceTopography/.
Installation
Installation is only possible on unix/linux systems and cumbersome on macOSX. For a quick start and if your OS is windows, consider running SurfaceTopography via our Docker container.
You first need to install requirements following our detailed instruction in the documentation.
Once the requirements are installed,
quick install with: python3 -m pip install SurfaceTopgography
Containerized SurfaceTopography
ContactEngineering provides container descriptions at the ce-container-stack.
For getting started quickly with Docker and SurfaceTopography
in a ready-to-run JupyterLab environment, try
docker run -p 8888:8888 imteksim/jupyterlab-surfacetopography:latest
Navigate to the JupyterLab server in your browser as instructed by the terminal output and launch a notebook with the SurfaceTopography
kernel.
Funding
Development of this project is funded by the European Research Council within Starting Grant 757343 and by the Deutsche Forschungsgemeinschaft within projects PA 2023/2 and EXC 2193.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for SurfaceTopography-1.2.1-py3.8-linux-x86_64.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 907ae51e4aafdc75bdf2e0eb76c0c077feb386ee2efafa4c3b80edc185cab2e3 |
|
MD5 | 117aa1ec6f6fc7317ba45b4574aeb581 |
|
BLAKE2b-256 | 6cdb06a900b37d1138f7f94fe05076d5896372a5ffe99e68dc9dc335484002d3 |