Metadata-Version: 2.1
Name: isthmuslib
Version: 0.0.99
Summary: Tooling for rapid data exploration, timeseries analysis, log extraction & visualization, etc
Home-page: https://github.com/mitchellpkt/python-isthmuslib
Author: Isthmus (Mitchell P. Krawiec-Thayer)
Author-email: isthmuslib@mitchellpkt.com
License: LGPL-3.0-only
Project-URL: Changelog, https://github.com/mitchellpkt/python-isthmuslib/blob/master/CHANGELOG.rst
Project-URL: Issue Tracker, https://github.com/mitchellpkt/python-isthmuslib/issues
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Python: >=3.8
License-File: LICENSE
License-File: AUTHORS.rst

========
Overview
========



Convenience utils for plotting, styling, and manipulating high-dimensional vectors.

* Analyses and plotting methods are one line to call, and produce consistently-formatted publication-ready plots.
* Enables rapid exploratory data analysis (EDA) and prototyping, perfect for taking a quick peek at data or making a quick figure to stash in the lab book (with labels and titles automatically included). See `examples here <https://github.com/Mitchellpkt/python-isthmuslib/blob/main/isthmuslib_tutorial.ipynb>`_.
* Designed for easy drop-in use for other projects, whether using internally to the code or for clean notebooks. Import isthmuslib to avoid writing many lines of plotting code when it would distract or detract from the main focus of your project.
* The visual and text configuration objects (:code:`Style` and :code:`Rosetta`, respectively) can be directly attached to a given data set, so you can "set it and forget it" at instantiation. All subsequent outputs will automatically have matching colors, sizes, labels, etc.
* The :code:`VectorSequence` object is designed for handling, plotting, and manipulating timeseries-like high-dimensional vectors. Its functionality includes: dimensionality reduction via singular vealue decomposition, seasonal (e.g. weekly, monthly, ...) timeseries decomposition, infosurface generation, and more.
* Uses industry standard libraries (pyplot, numpy, seaborn, pandas, etc) under the hood, and exposes their underlying functionality through the wrappers.

Free software for personal or academic use: **GNU Lesser General Public License v3 (LGPLv3).** Contact licensing@mitchellpkt.com for commercial applications.

Installation
============

::

    pip install isthmuslib

Documentation
=============


To use the project:

.. code-block:: python

    import isthmuslib


