Metadata-Version: 2.1
Name: digirock
Version: 0.1.2
Summary: Flexible tool to create custom digital rock models.
Home-page: https://github.com/trhallam/digirock/
Author-email: trhallam@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: xarray
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: numba
Requires-Dist: addict
Requires-Dist: more-itertools
Requires-Dist: rich
Requires-Dist: pooch
Provides-Extra: docs
Requires-Dist: mkdocs ; extra == 'docs'
Requires-Dist: mkdocstrings ; extra == 'docs'
Requires-Dist: mkdocs-material ; extra == 'docs'
Requires-Dist: mkdocs-material-extensions ; extra == 'docs'
Requires-Dist: mkdocs-simple-plugin ; extra == 'docs'
Requires-Dist: mkdocs-jupyter ; extra == 'docs'
Requires-Dist: mkautodoc ; extra == 'docs'
Requires-Dist: jupyterlab ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pandas ; extra == 'test'
Requires-Dist: numpy ; extra == 'test'
Requires-Dist: xarray ; extra == 'test'
Requires-Dist: hypothesis ; extra == 'test'

# digirock - [![latest-version](https://img.shields.io/pypi/v/digirock?color=006dad&label=pypi_version&logo=Python&logoColor=white)](https://pypi.org/project/digirock)

<p align="left">
    <a href="https://github.com/trhallam/digirock/actions"
       alt="Python Tests">
        <img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/trhallam/0da415ee1bf30b0fc37a2fc4ddafbdee/raw/digirock_test.json" />
    </a>
    <a href="https://github.com/trhallam/digirock/actions"
       alt="Python Test Coverage">
        <img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/trhallam/0da415ee1bf30b0fc37a2fc4ddafbdee/raw/digirock_coverage.json" />
    </a>
    <a href="https://trhallam.github.io/digirock/#project-layout"
       alt="Mkdocs">
        <img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/trhallam/0da415ee1bf30b0fc37a2fc4ddafbdee/raw/digirock_docs.json" />
    </a>
        <a href="https://github.com/psf/black"
       alt="black">
        <img src="https://img.shields.io/badge/code_style-black-000000.svg" />
    </a>
    </a>
        <a href="https://github.com/trhallam/digirock/blob/main/LICENSE"
       alt="License">
        <img src="https://img.shields.io/badge/license-MIT-brightgreen" />
    </a>
</p>

A set of classes for making flexible digital rock models.

## Installation

```bash
pip install digirock
```

## Usage

- TODO

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`digirock` was created by Tony Hallam. It is licensed under the terms of the MIT license.


