ondrolexa / polylx

A package to analyze and visualize rock microstructures

PolyLX - python package to visualize and analyze digitized 2D microstructures

Installation

PyPI

To install PolyLX, just execute

pip install polylx

Upgrading via pip

To upgrade an existing version of PolyLX from PyPI, execute

pip install polylx --upgrade --no-deps

Please note that the dependencies (Matplotlib, NumPy, Pandas, NetworkX, seaborn, shapely, pyshp and SciPy) will also be upgraded if you omit the --no-deps flag; use the --no-deps ("no dependencies") flag if you don't want this.

Installing PolyLX with conda or mamba

Another common way to install is create environment using conda or mamba. Download latest version of polylx and unzip to folder of your choice. Use conda or mamba to create an environment from an environment.yml file. Open the terminal, change directory where you unzip the source and execute following command:

conda env create -f environment.yml

Activate the new environment and install from current directory::

conda activate polylx
pip install polylx

Documentation

Explore the full features of PolyLX. You can find detailed documentation here.

Contributing

Most discussion happens on Github. Feel free to open an issue 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.