polylx


Namepolylx JSON
Version 0.6.1 PyPI version JSON
download
home_pageNone
SummaryA Python package to visualize and analyze microstructures
upload_time2025-01-24 11:41:16
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords geology microstructures
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PolyLX - python package to visualize and analyze digitized 2D microstructures

[![PyPI version](https://badge.fury.io/py/polylx.svg)](https://badge.fury.io/py/polylx)
[![Testing](https://github.com/ondrolexa/polylx/actions/workflows/pythontest.yml/badge.svg?event=push)](https://github.com/ondrolexa/polylx)
[![Documentation Status](https://readthedocs.org/projects/polylx/badge/?version=stable)](https://polylx.readthedocs.io/en/stable/?badge=stable)
[![DOI](https://zenodo.org/badge/30773592.svg)](https://zenodo.org/badge/latestdoi/30773592)

## Installation

### PyPI

To install PolyLX, create virtual environment, activate it and install with pip:
```
python -m venv polylx
source polylx/bin/activate
pip install polylx
```

#### Upgrading via pip

To upgrade an existing version of PolyLX from PyPI, execute:
```
pip install polylx --upgrade
```

### Installing PolyLX with mamba

Another common way to install is create environment using mamba (or conda with conda-forge repository):

```
mamba create -n polylx numpy matplotlib scipy pandas pyarrow seaborn networkx shapely pyshp fiona jupyterlab pyefd jenkspy shapelysmooth
```

Activate the new environment and install with pip:

```
mamba activate polylx
pip install polylx
```

## Documentation

Explore the full features of PolyLX. You can find detailed documentation [here](https://polylx.readthedocs.org).

## Contributing

Most discussion happens on [Github](https://github.com/ondrolexa/polylx). Feel free to open [an issue](https://github.com/ondrolexa/polylx/issues/new) or comment on any open issue or pull request. Check ``CONTRIBUTING.md`` for more details.

## License

PolyLX is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in ``LICENSE`` file.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "polylx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Ondrej Lexa <lexa.ondrej@gmail.com>",
    "keywords": "geology, microstructures",
    "author": null,
    "author_email": "Ondrej Lexa <lexa.ondrej@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/63/11/0bde5c38af1f1e8a9e100b79ba39826c825f51f16ac0b81f3fe1074c15f4/polylx-0.6.1.tar.gz",
    "platform": null,
    "description": "# PolyLX - python package to visualize and analyze digitized 2D microstructures\n\n[![PyPI version](https://badge.fury.io/py/polylx.svg)](https://badge.fury.io/py/polylx)\n[![Testing](https://github.com/ondrolexa/polylx/actions/workflows/pythontest.yml/badge.svg?event=push)](https://github.com/ondrolexa/polylx)\n[![Documentation Status](https://readthedocs.org/projects/polylx/badge/?version=stable)](https://polylx.readthedocs.io/en/stable/?badge=stable)\n[![DOI](https://zenodo.org/badge/30773592.svg)](https://zenodo.org/badge/latestdoi/30773592)\n\n## Installation\n\n### PyPI\n\nTo install PolyLX, create virtual environment, activate it and install with pip:\n```\npython -m venv polylx\nsource polylx/bin/activate\npip install polylx\n```\n\n#### Upgrading via pip\n\nTo upgrade an existing version of PolyLX from PyPI, execute:\n```\npip install polylx --upgrade\n```\n\n### Installing PolyLX with mamba\n\nAnother common way to install is create environment using mamba (or conda with conda-forge repository):\n\n```\nmamba create -n polylx numpy matplotlib scipy pandas pyarrow seaborn networkx shapely pyshp fiona jupyterlab pyefd jenkspy shapelysmooth\n```\n\nActivate the new environment and install with pip:\n\n```\nmamba activate polylx\npip install polylx\n```\n\n## Documentation\n\nExplore the full features of PolyLX. You can find detailed documentation [here](https://polylx.readthedocs.org).\n\n## Contributing\n\nMost discussion happens on [Github](https://github.com/ondrolexa/polylx). Feel free to open [an issue](https://github.com/ondrolexa/polylx/issues/new) or comment on any open issue or pull request. Check ``CONTRIBUTING.md`` for more details.\n\n## License\n\nPolyLX is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in ``LICENSE`` file.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python package to visualize and analyze microstructures",
    "version": "0.6.1",
    "project_urls": {
        "Changelog": "https://github.com/ondrolexa/polylx/blob/master/CHANGELOG.md",
        "Documentation": "https://polylx.readthedocs.io/",
        "Homepage": "https://github.com/ondrolexa/polylx",
        "Issues": "https://github.com/ondrolexa/polylx/issues",
        "Repository": "https://github.com/ondrolexa/polylx.git"
    },
    "split_keywords": [
        "geology",
        " microstructures"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "853ba453bd30135a539b30f0c15acc8838818a0668060bc963acdedd7831ea61",
                "md5": "64f390c5ed87bf3cab913afa0eac43c6",
                "sha256": "199ec5e251a40bbbff8028fe1d78bcdb5325dcd4a13162fe0d6fd9eade7a2875"
            },
            "downloads": -1,
            "filename": "polylx-0.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64f390c5ed87bf3cab913afa0eac43c6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 500200,
            "upload_time": "2025-01-24T11:41:13",
            "upload_time_iso_8601": "2025-01-24T11:41:13.574339Z",
            "url": "https://files.pythonhosted.org/packages/85/3b/a453bd30135a539b30f0c15acc8838818a0668060bc963acdedd7831ea61/polylx-0.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "63110bde5c38af1f1e8a9e100b79ba39826c825f51f16ac0b81f3fe1074c15f4",
                "md5": "0e3c4f8b04074c6a1067fcbbd281c577",
                "sha256": "7eb91ecfca0f2cc8b906de856149d7566f1a948dc92f3331c550d099d7de187a"
            },
            "downloads": -1,
            "filename": "polylx-0.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0e3c4f8b04074c6a1067fcbbd281c577",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 1657731,
            "upload_time": "2025-01-24T11:41:16",
            "upload_time_iso_8601": "2025-01-24T11:41:16.381268Z",
            "url": "https://files.pythonhosted.org/packages/63/11/0bde5c38af1f1e8a9e100b79ba39826c825f51f16ac0b81f3fe1074c15f4/polylx-0.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-24 11:41:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ondrolexa",
    "github_project": "polylx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "polylx"
}
        
Elapsed time: 0.66389s