Metadata-Version: 2.2
Name: Plume-Learn
Version: 1.1.1
Summary: A Python package for visualizing and analyzing plume dynamics during thin-film growth, providing tools to process, visualize, and extract meaningful insights from in-situ plume images captured during Pulsed Laser Deposition (PLD) experiments.
Home-page: https://github.com/pyscaffold/pyscaffold/
Author: Yichen Guo
Author-email: yig319@lehigh.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>/Plume-Learn.svg?branch=main
        :alt: Built Status
        :target: https://cirrus-ci.com/github/<USER>/Plume-Learn
    .. image:: https://readthedocs.org/projects/Plume-Learn/badge/?version=latest
        :alt: ReadTheDocs
        :target: https://Plume-Learn.readthedocs.io/en/stable/
    .. image:: https://img.shields.io/coveralls/github/<USER>/Plume-Learn/main.svg
        :alt: Coveralls
        :target: https://coveralls.io/r/<USER>/Plume-Learn
    .. image:: https://img.shields.io/pypi/v/Plume-Learn.svg
        :alt: PyPI-Server
        :target: https://pypi.org/project/Plume-Learn/
    .. image:: https://img.shields.io/conda/vn/conda-forge/Plume-Learn.svg
        :alt: Conda-Forge
        :target: https://anaconda.org/conda-forge/Plume-Learn
    .. image:: https://pepy.tech/badge/Plume-Learn/month
        :alt: Monthly Downloads
        :target: https://pepy.tech/project/Plume-Learn
    .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
        :alt: Twitter
        :target: https://twitter.com/Plume-Learn

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

|

===========
Plume-Learn
===========


    A Python package for visualizing and analyzing plume dynamics during thin-film growth, providing tools to process, visualize, and extract meaningful insights from in-situ plume images captured during Pulsed Laser Deposition (PLD) experiments.


This Python package offers a comprehensive set of tools for the analysis and visualization of plume dynamics data, allowing researchers to study the evolution of plume behavior during thin-film deposition processes. The package simplifies the process of handling raw image data, including image filtering, motion tracking, and plume velocity/shape analysis. Built-in functions enable users to visualize plume evolution over time in both 2D and 3D.

Key Features
------------

- Support for common image formats from in-situ plume imaging systems (e.g., .tiff, .png).
- Real-time visualization of plume frame during film growth.
- Tools for plume shape analysis, velocity estimation, and dynamic behavior tracking.
- Customizable workflows for advanced material growth analysis, including plume morphology and deposition rate correlations.

This package is ideal for materials science researchers and PLD users looking to gain insights into plume dynamics during thin-film deposition and optimize the growth process for better material quality.
    

.. _pyscaffold-notes:

Note
====

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