semvec/pypi-packages huggingface dataset:
pyplot7k 1.0.1
Pyplot7k is a library for plotting 7k data
Requires Python: >=3.8

[![Teledyne Logo](https://raw.githubusercontent.com/Teledyne-Marine/pyplot7k/master/images/TeledyneLogo.png)](teledynemarine.com)


# Pyplot7k
Pyplot7k is a library for plotting 7k data.


# Installation
The library can be installed using pip, directly from PyPI, or from the Teledyne github repository as seen below. All dependencies should be automatically installed.
```bash
pip install pyplot7k
pip install git+https://github.com/Teledyne-Marine/pyplot7k.git
```


# Getting started
Working with pyplot7k is quite intuitive. In its most basic form, a wedge can be created by simply passing a pyread7k ping into plot_wedge_from_ping()
```python
from pyread7k import PingDataset, PingType
from pyplot7k import *
import matplotlib.pyplot as plt

dataset = PingDataset("path/to/file.s7k", include=PingType.BEAMFORMED)
ping = dataset[0] # First ping of the dataset

fig, ax = plt.subplots()

plot_wedge_from_ping(
    ping,
    ax=ax,
)

plt.show()
```


# Output example
![Wedge plot](https://raw.githubusercontent.com/Teledyne-Marine/pyplot7k/master/images/wedge_plot_example.png)


# Dependencies
* `Python` 3.8 or later
* `pyread7k`
* `scipy`
* `scikit-image`
* `matplotlib`


# License
Copyright 2021 Teledyne RESON A/S
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.