Merge branch 'dev'

fraunhoferportugal · Nov 24, 2023 · 0fe460a · 0fe460a
2 parents e7d810c + d34e5a2
commit 0fe460a
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 27 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,24 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+   - method: pip
+     path: .
+     extra_requirements:
+        - docs
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -20,6 +20,7 @@ Lead Development Team
 Contributors
 ------------
 - Hui Liu
+- Isabel Curioso
 - Letícia Fernandes
 - Mariana Abreu
 - Patrícia Bota
@@ -29,7 +30,7 @@ Contributors
 
 Citing TSFEL
 --------------
-TSFEL was published in Barandas, Marília and Folgado, Duarte, et al. "*TSFEL: Time Series Feature Extraction Library.*" SoftwareX 11 (2020). [https://doi.org/10.1016/j.softx.2020.100456](https://doi.org/10.1016/j.softx.2020.100456)
+TSFEL was published in Barandas, Marília and Folgado, Duarte, et al. "*TSFEL: Time Series Feature Extraction Library.*" SoftwareX 11 (2020). `https://doi.org/10.1016/j.softx.2020.100456 <https://doi.org/10.1016/j.softx.2020.100456>`_.
 
 If you used TSFEL in your scientific publication, we would very appreciated if you include the adequate citation:
 

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-[![Documentation Status](https://readthedocs.org/projects/tsfel/badge/?version=latest)](https://tsfel.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/tsfel/badge/?version=dev)](https://tsfel.readthedocs.io/en/dev/?badge=dev)
 [![license](https://img.shields.io/badge/License-BSD%203-brightgreen)](https://github.com/fraunhoferportugal/tsfel/blob/master/LICENSE.txt)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tsfel)
 ![PyPI](https://img.shields.io/pypi/v/tsfel)
 [![Downloads](https://pepy.tech/badge/tsfel)](https://pepy.tech/project/tsfel)
-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fraunhoferportugal/tsfel/blob/master/notebooks/TSFEL_HAR_Example.ipynb)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fraunhoferportugal/tsfel/blob/dev/notebooks/TSFEL_HAR_Example.ipynb)
 
 # Time Series Feature Extraction Library
 ## Intuitive time series feature extraction
@@ -122,6 +122,9 @@ X = tsfel.time_series_features_extractor(cfg, df)
 | Wavelet entropy                   |          2         |
 | Wavelet variance                  |          2         |
 
+#### Fractal domain 
+:sparkles: **Coming Soon!** :hourglass_flowing_sand:
+
 
 ## Citing
 When using TSFEL please cite the following publication:

diff --git a/docs/conf.py b/docs/conf.py
@@ -20,15 +20,15 @@
 
 if os.environ.get('READTHEDOCS', None) == 'True':
     import inspect
-    from sphinx import apidoc
+    from sphinx.ext.apidoc import main
 
     __location__ = os.path.join(os.getcwd(), os.path.dirname(inspect.getfile(inspect.currentframe())))
 
     output_dir = os.path.join(__location__, "../docs/descriptions/modules")
     module_dir = os.path.join(__location__, "../tsfel")
     cmd_line_template = "sphinx-apidoc -f -o {outputdir} {moduledir}"
     cmd_line = cmd_line_template.format(outputdir=output_dir, moduledir=module_dir)
-    apidoc.main(cmd_line.split(" "))
+    main(cmd_line.split(" ")[1:])
 
 # -- General configuration ------------------------------------------------
 
@@ -61,24 +61,24 @@
 import datetime
 now = datetime.datetime.today()
 project = u'TSFEL'
-copyright = u'2021, Fraunhofer AICOS'
+copyright = u'2024, Fraunhofer AICOS'
 author = u'Fraunhofer AICOS'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'0.1.4'
+version = u'0.1.6'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1.4'
+release = u'0.1.6'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+# language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -192,4 +192,4 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,21 +17,6 @@ Highlights
 - **Unit tested**: we provide unit tests for each feature
 - **Easily extended**: adding new features is easy and we encourage you to contribute with your custom features
 
-Contents
-========
-
-.. toctree::
-   :maxdepth: 2
-
-   Get Started <descriptions/get_started>
-   Feature List <descriptions/feature_list>
-   Personalised Features <descriptions/personal>
-   Frequently Asked Questions <descriptions/faq>
-   Module Reference <descriptions/modules>
-   Authors <authors>
-   Changelog <changelog>
-   License <license>
-
 Installation
 ============
 
@@ -60,6 +45,29 @@ The code below extracts all the available features on an example dataset.
     # Extract features
     X = tsfel.time_series_features_extractor(cfg, df)
 
+How to cite TSFEL?
+==================
+
+.. admonition:: Note
+
+   Used TSFEL in your research? Please cite us in your publication!
+   Click :ref:`here<authors>` for further details.
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   Get Started <descriptions/get_started>
+   Feature List <descriptions/feature_list>
+   Personalised Features <descriptions/personal>
+   Frequently Asked Questions <descriptions/faq>
+   Module Reference <descriptions/modules>
+   Authors <authors>
+   Changelog <changelog>
+   License <license>
+
 Indices and tables
 ==================
 

diff --git a/requirements/requirements-docs.txt b/requirements/requirements-docs.txt
@@ -1 +1,2 @@
-Sphinx >= 1.8.5
+Sphinx >= 7.2.6
+sphinx-rtd-theme >= 1.3.0
diff --git a/tsfel/feature_extraction/calc_features.py b/tsfel/feature_extraction/calc_features.py
@@ -173,6 +173,7 @@ def calc_features(wind_sig, dict_features, fs, **kwargs):
     \**kwargs:
         * *features_path* (``string``) --
             Directory of script with personal features
+
          * *header_names* (``list or array``) --
             Names of each column window
 

diff --git a/tsfel/feature_extraction/features.py b/tsfel/feature_extraction/features.py
@@ -200,7 +200,7 @@ def distance(signal):
     Calculates the total distance traveled by the signal
     using the hypotenuse between 2 datapoints.
 
-   Feature computational cost: 1
+    Feature computational cost: 1
 
     Parameters
     ----------