Metadata-Version: 2.1
Name: AFM-Learn
Version: 0.3.0
Summary: Add a short description here!
Home-page: https://github.com/pyscaffold/pyscaffold/
Author: jagar2
Author-email: jca92@drexel.edu
License: MIT
Project-URL: Documentation, https://pyscaffold.org/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE.txt
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: testing
Requires-Dist: setuptools ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'

.. These are examples of badges you might want to add to your README:
   please update the URLs accordingly

    .. image:: https://api.cirrus-ci.com/github/<USER>/AFM-Learn.svg?branch=main
        :alt: Built Status
        :target: https://cirrus-ci.com/github/<USER>/AFM-Learn
    .. image:: https://readthedocs.org/projects/AFM-Learn/badge/?version=latest
        :alt: ReadTheDocs
        :target: https://AFM-Learn.readthedocs.io/en/stable/
    .. image:: https://img.shields.io/coveralls/github/<USER>/AFM-Learn/main.svg
        :alt: Coveralls
        :target: https://coveralls.io/r/<USER>/AFM-Learn
    .. image:: https://img.shields.io/pypi/v/AFM-Learn.svg
        :alt: PyPI-Server
        :target: https://pypi.org/project/AFM-Learn/
    .. image:: https://img.shields.io/conda/vn/conda-forge/AFM-Learn.svg
        :alt: Conda-Forge
        :target: https://anaconda.org/conda-forge/AFM-Learn
    .. image:: https://pepy.tech/badge/AFM-Learn/month
        :alt: Monthly Downloads
        :target: https://pepy.tech/project/AFM-Learn
    .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
        :alt: Twitter
        :target: https://twitter.com/AFM-Learn

.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
    :alt: Project generated with PyScaffold
    :target: https://pyscaffold.org/

|

=========
AFM-Learn
=========


    A Python package for visualizing and analyzing Atomic Force Microscopy(AFM) and Piezoelectric Force Microscopy(PFM) experimental data, offering tools to process, visualize, and extract meaningful insights from AFM images and measurements. 


This Python package provides a suite of tools for the visualization and analysis of Atomic Force Microscopy (AFM) experimental data. Designed for researchers working with AFM techniques, the package simplifies the processing of raw AFM data, including height, amplitude, and phase images. The built-in functionality allows users to visualize AFM scans in image and video if temporal dependent data, apply filters for noise reduction, and extract key metrics such as roughness, feature dimensions, and ferroelectric domain structures.

Key features include:

- Support for AFM data formats (e.g., .ibw).
- Convenient image and video visualization of AFM data.
- Data filtering and smoothing techniques.
- Customizable functions for ferroelectric domain structure analysis.

This package is particularly useful for materials science researchers and AFM users who want to streamline data processing and explore advanced data processing and analysis.

.. _pyscaffold-notes:

Note
====

This project has been set up using PyScaffold 4.6. For details and usage
information on PyScaffold see https://pyscaffold.org/.
