py-droplets


Namepy-droplets JSON
Version 0.20.0 PyPI version JSON
download
home_page
SummaryPython package for describing and analyzing droplets in experiments and simulations
upload_time2024-02-08 19:35:50
maintainer
docs_urlNone
author
requires_python<3.13,>=3.9
licenseMIT
keywords emulsions image-analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # py-droplets

[![Build Status](https://github.com/zwicker-group/py-droplets/actions/workflows/python_tests.yml/badge.svg)](https://github.com/zwicker-group/py-droplets/actions/workflows/python_tests.yml)
[![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)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/py-droplets.svg)](https://anaconda.org/conda-forge/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)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

`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) and 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
```

As an alternative, you can install `py-droplets` through [conda](https://docs.conda.io/en/latest/)
using the [conda-forge](https://conda-forge.org/) channel:

```bash
conda install -c conda-forge py-droplets
```


Usage
-----

More information
----------------
* Tutorial notebook in the [tutorials folder](https://github.com/zwicker-group/py-droplets/tree/master/examples/tutorial)
* Examples in the [examples folder](https://github.com/zwicker-group/py-droplets/tree/master/examples)
* [Full documentation on readthedocs](https://py-droplets.readthedocs.io/)
  or as [a single PDF file](https://py-droplets.readthedocs.io/_/downloads/en/latest/pdf/).

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "py-droplets",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.13,>=3.9",
    "maintainer_email": "",
    "keywords": "emulsions,image-analysis",
    "author": "",
    "author_email": "David Zwicker <david.zwicker@ds.mpg.de>",
    "download_url": "https://files.pythonhosted.org/packages/53/31/3b08e25081f4a0fcfae36955296dfe7de28b423ba6636a2030fd798f146a/py-droplets-0.20.0.tar.gz",
    "platform": null,
    "description": "# py-droplets\n\n[![Build Status](https://github.com/zwicker-group/py-droplets/actions/workflows/python_tests.yml/badge.svg)](https://github.com/zwicker-group/py-droplets/actions/workflows/python_tests.yml)\n[![Documentation Status](https://readthedocs.org/projects/py-droplets/badge/?version=latest)](https://py-droplets.readthedocs.io/en/latest/?badge=latest)\n[![PyPI version](https://badge.fury.io/py/py-droplets.svg)](https://badge.fury.io/py/py-droplets)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/py-droplets.svg)](https://anaconda.org/conda-forge/py-droplets)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n[![codecov](https://codecov.io/gh/zwicker-group/py-droplets/branch/master/graph/badge.svg)](https://codecov.io/gh/zwicker-group/py-droplets)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n`py-droplets` provides python code for representing physical droplets using\nkey parameters like position, size, or shape.\nThese droplets can also be represented as collections (emulsions) and over time.\nMoreover, the package provides methods for locating droplets in microscope\nimages or phase field data from simulations.\n\n\nInstallation\n------------\n\n`py-droplets` is available on `pypi`, so you should be able to install it\nthrough `pip`:\n\n```bash\npip install py-droplets\n```\n\nAs an alternative, you can install `py-droplets` through [conda](https://docs.conda.io/en/latest/)\nusing the [conda-forge](https://conda-forge.org/) channel:\n\n```bash\nconda install -c conda-forge py-droplets\n```\n\n\nUsage\n-----\n\nMore information\n----------------\n* Tutorial notebook in the [tutorials folder](https://github.com/zwicker-group/py-droplets/tree/master/examples/tutorial)\n* Examples in the [examples folder](https://github.com/zwicker-group/py-droplets/tree/master/examples)\n* [Full documentation on readthedocs](https://py-droplets.readthedocs.io/)\n  or as [a single PDF file](https://py-droplets.readthedocs.io/_/downloads/en/latest/pdf/).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python package for describing and analyzing droplets in experiments and simulations",
    "version": "0.20.0",
    "project_urls": {
        "documentation": "http://py-droplets.readthedocs.io",
        "homepage": "https://github.com/zwicker-group/py-droplets",
        "repository": "https://github.com/zwicker-group/py-droplets"
    },
    "split_keywords": [
        "emulsions",
        "image-analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9c6ea5aaac5f8cccaca2506fdb0ad4edb01e4b76c816c637265112d886c84050",
                "md5": "0201623d5f2d476f321a68f1dbd82b8b",
                "sha256": "ac92274065d7e6715d6a9db33788e2e9f2f8917eea0674db6b047117da472d74"
            },
            "downloads": -1,
            "filename": "py_droplets-0.20.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0201623d5f2d476f321a68f1dbd82b8b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.9",
            "size": 171866,
            "upload_time": "2024-02-08T19:35:49",
            "upload_time_iso_8601": "2024-02-08T19:35:49.231848Z",
            "url": "https://files.pythonhosted.org/packages/9c/6e/a5aaac5f8cccaca2506fdb0ad4edb01e4b76c816c637265112d886c84050/py_droplets-0.20.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "53313b08e25081f4a0fcfae36955296dfe7de28b423ba6636a2030fd798f146a",
                "md5": "4742a9f9bc429f853de825ae60f8e3a9",
                "sha256": "a3d70d27af30babda952c30801aac6eb38e577a3d610b26028c3b7a53818b1a9"
            },
            "downloads": -1,
            "filename": "py-droplets-0.20.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4742a9f9bc429f853de825ae60f8e3a9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.9",
            "size": 551747,
            "upload_time": "2024-02-08T19:35:50",
            "upload_time_iso_8601": "2024-02-08T19:35:50.570483Z",
            "url": "https://files.pythonhosted.org/packages/53/31/3b08e25081f4a0fcfae36955296dfe7de28b423ba6636a2030fd798f146a/py-droplets-0.20.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-08 19:35:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zwicker-group",
    "github_project": "py-droplets",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "py-droplets"
}
Elapsed time: 0.20033s