mplStrater: plot stratigraphic columns with python
==================================================

.. image:: https://img.shields.io/pypi/pyversions/mplStrater
    :alt: PyPI - Python Version 

.. image:: https://img.shields.io/pypi/v/mplStrater?color=blue   
    :alt: PyPI

.. image:: https://img.shields.io/github/release-date/giocaizzi/mplStrater 
    :alt: GitHub Release Date

.. image:: https://img.shields.io/github/workflow/status/giocaizzi/mplStrater/mplStrater/main 
    :alt: GitHub Workflow Status (branch)

.. image:: https://img.shields.io/codecov/c/github/giocaizzi/mplStrater 
    :alt: Codecov

.. image:: https://requires.io/github/giocaizzi/mplStrater/requirements.svg?branch=main 
    :target: https://requires.io/github/giocaizzi/mplStrater/requirements/?branch=main
    :alt: Requirements Status

.. image:: https://img.shields.io/github/license/giocaizzi/mplStrater 
    :alt: license

.. image:: https://img.shields.io/github/issues/giocaizzi/mplStrater 
    :alt: issues


This package allows to plot stratigraphic columns with python.

Passing to :code:`mplStrater`:

* some stratigraphic data stored in a ``pandas.DataFrame``
* a :code:`mplStrater.Legend` object

the package creates a series of :code:`mplStrater.strata.Columns` objects
that can be plotted, all together or singularly, on :code:`matplotlib.axes`. The columns
are plotted with the color and hatch scheme defined providing the legend object.

.. figure :: images/map.png
    
    Output map of the example dataset.

The package also allows to plot singularly column contained in the dataset.

.. figure :: images/columns.jpeg
    
    It allows to plot the single columns for closer inspection.

Packaged from a hardcoded script in quarantine in december 2021, by `@giocaizzi <https://github.com/giocaizzi>`_.

.. toctree::
   :maxdepth: 2
   :caption: Examples:

   examples/data.ipynb
   examples/strata.ipynb
   examples/stratigraphic_map.ipynb

Code reference
==============

.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst
   :caption: Code reference:
   :recursive:

   mplStrater

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`