Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.46 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.46 KB

sigmet

Github Tests Documentation Status GitHub license Downloads

Installation

Sigmet (Signal Metrics Toolkit) is an end-to-end solution for the detection and measurement of negative shocks in time series data.

Sigmet requires the following packages:

  • Pandas: primary data format for easy data manipulation and datetime functionality
  • Numpy: for computation
  • Statsmodels: AU3 uses statsmodel’s ARIMA and SARIMAX models for prediction
  • Matplotlib: plotting for .graph() method

To install, run the following on the command line

pip install sigmet

Example

First we instantiate an AU3 object

from sigmet import Sigmet
    
data = pd.read_csv('time-series.csv')
ex = Sigmet(start, end, data)
ex.fit(window_start, window_end)

# graph the result as follows
import matplotlib.pyplot as plt
fig, ax = plt.subplots()
ax = ex.graph()
plt.show()

Contribute

License

The project is licensed under the GNU General Public License.