Metadata-Version: 1.1
Name: sliceplots
Version: 0.1.2
Summary: thin wrapper on top of matplotlib's imshow for 2D plotting with attached slice plots
Home-page: https://github.com/berceanu/sliceplots
Author: Andrei Berceanu
Author-email: andreicberceanu@gmail.com
License: BSD license
Description: ==========
        sliceplots
        ==========
        
        
        .. image:: https://img.shields.io/pypi/v/sliceplots.svg
                :target: https://pypi.python.org/pypi/sliceplots
        
        .. image:: https://img.shields.io/travis/berceanu/sliceplots.svg
                :target: https://travis-ci.org/berceanu/sliceplots
        
        .. image:: https://readthedocs.org/projects/sliceplots/badge/?version=latest
                :target: https://sliceplots.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        .. image:: https://pyup.io/repos/github/berceanu/sliceplots/shield.svg
             :target: https://pyup.io/repos/github/berceanu/sliceplots/
             :alt: Updates
        
        
        
        thin wrapper on top of ``matplotlib``'s ``.imshow()`` for 2D plotting, with attached slice plots
        
        
        * Free software: BSD license
        * Documentation: https://sliceplots.readthedocs.io
        
        Features
        --------
        
        * only depends on ``matplotlib``
        * uses its pure OO (look Ma, no ``pyplot``!) interface
        * support for 1D and 2D plots with various customization options
        * broken-axis 1D plots
        
        Quick start
        -----------
        
        Install the package via:
        
        .. code-block:: console
        
                $ pip install sliceplots
        
        Generate a quick slice plot:
        
        .. code-block:: python
        
                import numpy as np
                import sliceplots.two_dimensional as two_d
        
                axis_data = np.linspace(0, np.pi, 128)
                data_2d = np.cos(axis_data - 0.5) * np.cos(axis_data.reshape(-1, 1) - 1.0)
        
                p2d = two_d.Plot2D(
                    data_2d,
                    axis_data,  # horiz. axis
                    axis_data,  # vert. axis
                    xlabel="x",
                    ylabel="y",
                    zlabel="f(x,y)",
                    hslice_val=0.75,
                    vslice_val=2.75,
                )
                p2d.fig.savefig("imshow_slices.png")
        
        .. image:: https://raw.githubusercontent.com/berceanu/sliceplots/master/tests/baseline/imshow_slices.png
        
        Credits
        -------
        
        Big thanks to `@afvincent`_ for `his gist`_.
        
        .. _`@afvincent`: https://github.com/afvincent
        .. _`his gist`: https://gist.github.com/afvincent/0e6b743e32a3fa62b580657693163b7e
        
        
        =======
        History
        =======
        
        0.0.1 (2019-06-16)
        ------------------
        
        * First release on PyPI.
        
        0.1.0 (2019-06-17)
        ------------------
        
        * Added regression tests, usage and docstrings.
        
        0.1.1 (2019-06-19)
        ------------------
        
        * Fixed label positions and colors.
        
Keywords: slice plot plotting
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python :: 3.6
