Metadata-Version: 2.4
Name: lcmto
Version: 0.1.0
Summary: A package for parsing LCM log files
Project-URL: homepage, https://github.com/mbari-org/lcmto
Project-URL: repository, https://github.com/mbari-org/lcmto
Project-URL: documentation, https://github.com/mbari-org/lcmto/wiki
Author-email: "Eric Martin (MBARI)" <emartin@mbari.org>
License: Copyright (c) 2019 Monterey Bay Aquarium Research Institute
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: LCM,log,parsing
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Dist: lcm
Requires-Dist: pandas
Description-Content-Type: text/markdown

# LCMTO LCM log conversion utility

This is a simple package for use on Python (>3.6) that facilitates conversion of LCM files into Pandas dataframes and CSV files.

## Installation

You must have LCM installed, and source can be found on the [LCM Github page](https://lcm-proj.github.io).

Install the package by navigating to the directory containing `setup.py` and execute the following command:

    python setup.py build && python setup.py install
    
## Getting Started

Once installed, this utility assumes you have employed [`lcm-gen`](https://linux.die.net/man/1/lcm-gen) to generate types and have those available to your python environment, either installed in your site-packages, or referenced through export of `PYTHONPATH` or within code using `sys.path.append`. 

### Reading in a Dataframe

See the help for `lcmto.dataframe()`

### Creating a CSV-file

See the help for `lcmto.csv()'

