Merge pull request #16 from MideTechnology/release/1.0.0

Release 1.0.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Mide Technology Corp.
+
+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.

README.md

@@ -0,0 +1,61 @@
+# endaq-plot - Painless Plotting Of Sensor Data
+
+endaq-plot is a package comprising a collection of plotting utilities for sensor data analysis. It leverages Plotly in order to produce interactive plots, and makes creating powerful visualizations simple and easy for those new to Python.
+
+endaq-plot is a sub-package of the larger enDAQ ecosystem. See [the endaq package](https://github.com/MideTechnology/endaq-python) for more details.
+
+## Installation
+
+endaq-plot is available on PYPI via `pip`:
+
+    pip install endaq-plot
+
+For the most recent features that are still under development, you can also use `pip` to install endaq-plot directly from GitHub:
+
+    pip install git+https://github.com/MideTechnology/endaq-python-plot.git@development
+
+## Usage Examples
+
+For these examples we assume there is a Pandas DataFrame named `df` which has it's index as time stamps and it's one column being sensor values (e.g. x-axis accleration, or pressure).   It also assumes there is a Pandas DataFrame `attribute_df` which contains all the attribute data about various data files.  More information can be found about how to get this data from enDAQ IDE files in the [endaq-cloud package](https://github.com/MideTechnology/endaq-python-cloud).
+
+```python
+from endaq.plot import octave_spectrogram, multi_file_plot_attributes, octave_psd_bar_plot
+from endaq.plot.utilities import set_theme
+```
+
+### Setting The Aesthetic Theme
+
+```python
+set_theme(theme='endaq')
+```
+
+### Creating Spectrograms With Octave Spaced Frequencies
+
+```python
+freqs, bins, Pxx, fig = octave_spectrogram(df, window=.15)
+fig.show()
+```
+
+![Spectrogram With Octave Spaced Frequencies](https://i.imgur.com/929aszu.png)
+
+### Creating PSD Bar Plots With Octave Spaced Frequencies
+
+```python
+fig = octave_psd_bar_plot(df, yaxis_title="Magnitude")
+fig.show()
+```
+
+![PSD Bar Plot With Octave Spaced Frequencies](https://i.imgur.com/ueqcVTQ.png)
+
+### Plot Attributes In Figure With Subplots
+
+```Python
+fig = multi_file_plot_attributes(attribute_df)
+fig.show()
+```
+
+![Attributes Plotted As Subplots](https://i.imgur.com/5Yy4DN7.png)
+
+## Other Links
+- the endaq package - https://github.com/MideTechnology/endaq-python
+- the enDAQ homepage - https://endaq.com/

endaq/plot/__init__.py

@@ -0,0 +1 @@
+from .plots import *