New tsfresh logo!

CHANGES.rst

@@ -10,6 +10,7 @@ Unreleased
     - Implemented the Lempel-Ziv-Complexity and the Fourier Entropy (#688)
     - Prevent #524 by adding an assert for common identifiers (#690)
     - Added permutation entropy (#691)
+    - Added a logo :-) (#694)
 
 Version 0.16.0
 ==============

README.md

@@ -1,3 +1,11 @@
+<div align="center">
+  <img width="70%" src="./docs/images/tsfresh_logo.svg">
+</div>
+
+-----------------
+
+# tsfresh
+
 [![Documentation Status](https://readthedocs.org/projects/tsfresh/badge/?version=latest)](https://tsfresh.readthedocs.io/en/latest/?badge=latest)
 [![Build Status](https://travis-ci.org/blue-yonder/tsfresh.svg?branch=master)](https://travis-ci.org/blue-yonder/tsfresh)
 [![Coverage Status](https://coveralls.io/repos/github/blue-yonder/tsfresh/badge.svg?branch=master)](https://coveralls.io/github/blue-yonder/tsfresh?branch=master)
@@ -7,9 +15,6 @@
 [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/blue-yonder/tsfresh/master?filepath=notebooks)
 [![Downloads](https://pepy.tech/badge/tsfresh)](https://pepy.tech/project/tsfresh)
 
-
-# tsfresh
-
 This repository contains the *TSFRESH* python package. The abbreviation stands for
 
 *"Time Series Feature extraction based on scalable hypothesis tests"*.

docs/conf.py

@@ -126,7 +126,9 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-# html_theme_options = {}
+html_theme_options = {
+    "style_nav_header_background": "#51b63c"
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []

docs/index.rst

@@ -1,3 +1,8 @@
+.. image:: images/tsfresh_logo.svg
+   :width: 70 %
+   :alt: some characteristics of the time series
+   :align: center
+
 =======
 tsfresh
 =======

docs/text/quick_start.rst

@@ -36,9 +36,9 @@ To start, we load the data into python
 and end up with a pandas.DataFrame `timeseries` having the following shape
 
 .. code:: python
-   
+
    print(timeseries.head())
-   
+
 +-----+-----+-----+-----+-----+-----+-----+-----+-----+
 |     | id  | time| F_x | F_y | F_z | T_x | T_y | T_z |
 +=====+=====+=====+=====+=====+=====+=====+=====+=====+
@@ -85,7 +85,6 @@ In the following we illustrate the time series of the sample id 3 reporting no f
     plt.show()
 
 .. image:: ../images/ts_example_robot_failures_nofail.png
-   :scale: 100 %
    :alt: the time series for id 3 (no failure)
    :align: center
 
@@ -98,7 +97,6 @@ And for id 20 reporting a failure:
     plt.show()
 
 .. image:: ../images/ts_example_robot_failures_fail.png
-   :scale: 100 %
    :alt: the time series for id 20 (failure)
    :align: center