Metadata-Version: 2.1
Name: py-droplets
Version: 0.2
Summary: Python package for describing and analyzing droplets in experiments and simulations
Home-page: https://github.com/zwicker-group/py-droplets
Author: David Zwicker
Author-email: david.zwicker@ds.mpg.de
License: MIT
Download-URL: https://github.com/zwicker-group/py-droplets/archive/v0.2.tar.gz
Keywords: emulsions,image-analysis
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: scipy
Requires-Dist: sympy
Requires-Dist: py-pde

# py-droplets

[![Build Status](https://travis-ci.org/zwicker-group/py-droplets.svg?branch=master)](https://travis-ci.org/zwicker-group/py-droplets)
[![Documentation Status](https://readthedocs.org/projects/py-droplets/badge/?version=latest)](https://py-droplets.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/py-droplets.svg)](https://badge.fury.io/py/py-droplets)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![codecov](https://codecov.io/gh/zwicker-group/py-droplets/branch/master/graph/badge.svg)](https://codecov.io/gh/zwicker-group/py-droplets)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/zwicker-group/py-droplets.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/zwicker-group/py-droplets/context:python)

`py-droplets` provides python code for representing physical droplets using
key parameters like position, size, or shape.
These droplets can also be represented as collections (emulsions) over time.
Moreover, the package provides methods for locating droplets in microscope
images or phase field data from simulations.


Installation
------------

`py-droplets` is available on `pypi`, so you should be able to install it
through `pip`:

```bash
pip install py-droplets
```

In order to have all features of the package available, you might also want to 
install the following optional packages:

```bash
pip install h5py tqdm
```


Usage
-----

Examples illustrating the capabilities of the package can be found in the
 `examples` folder.
A detailed [documentation is available on readthedocs](https://py-droplets.readthedocs.io/)
and as [a single PDF file](https://py-droplets.readthedocs.io/_/downloads/en/latest/pdf/).



