Merge branch 'fathon-dev'

CONTRIBUTING.md

@@ -1,78 +1,23 @@
 # Contributing to fathon
 
+If you have found bugs, or you want to propose a new feature:
 
+1. describe the problem and specify the details of your setup (OS, Python version, environment, etc.);
+2. provide a minimal working example that can be easily reproduced and tested;
+3. open an issue with the previous information in the GitHub repository with tag <code>bug</code> or <code>proposed feature</code>.
 
-## Bug fixes and new features
+PRs are also welcomed.
 
-If you have found or fixed bugs, or you want to propose or add a new feature, please follow these instructions.
-
-#### To report a bug:
-
-1. Describe the problem accurately and specify the details of your setup (OS, Python version, environment, etc.);
-2. Provide a minimal working example that can be easily reproduced and tested;
-3. Open an issue with the previous information in the Github repository with tag <code>bug</code>.
-
-#### To fix a bug:
-
-1. Fork the repository;
-2. If the bug involves Cython code and you know Cython:
-   - Fix the bug;
-   - Describe the bug, provide a minimal working example that can be easily reproduced and tested to reproduce the bug, and explain how you fixed it;
-   - Create a pull request including what described in the previous point.
-3. If the bug involves Cython code and you do not know Cython:
-   - Simply report the bug as described in "To report a bug".
-4. If the bug involves Python code:
-   - Follow the same instructions given in point 2.
-
-#### To propose a new feature:
-
-1. Open an issue in the Github repository with tag  <code>proposed feature</code>;
-2. Please try to give a detailed description of the feature, providing references if available.
-
-#### To add a new feature:
-
-1. Fork the repository;
-
-2. If the new feature needs to be written in Cython and you know Cython:
-
-   - Develop the new code;
-
-   - Describe the new feature and provide references if available, provide a minimal working example that can be easily reproduced and tested, and list all the added or modified repository's files;
-
-   - Create a pull request including what described in the previous point.
-
-3. If the new feature needs to be written in Cython and you do not know Cython:
-
-   - Develop the new code in Python;
-   - Describe the new feature and provide references if available, provide the new code with information on where to include it, and provide a minimal working example that can be easily reproduced and tested;
-   - Open an issue with the previous information in the Github repository with tag  <code>new feature</code>;
-   - I will review it and translate the code to Cython.
-
-4. If the new feature can be written in Python:
-
-   - Follow the same instructions given in point 2.
-
-#### For any other question regarding the package:
-
-1. Open an issue as described in "To report a bug", but with tag <code>question</code>, or write to [email protected].
-
-
-
-## Code formatting
-
-The current code is formatted using tabs.
-
-In case you are going to modify `fathon`, please use the same docstring format already present in the source files.
+For any other question, open an issue with tag <code>question</code>.
 
 
 
 ## Documentation
 
-Documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html), built with <code>sphinx</code> and placed in the <code>docs</code> folder. If you have contributed, please update also the documentation.
+Documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html), built with <code>sphinx</code> and placed in the <code>docs</code> folder.
+
+The script  <code>docs_gen.sh</code> generates `.py` files with only docstrings, since `sphinx` does not support Cython.
 
-- Add or modify the function/class in the corresponding <code>.rst</code> file in the folder <code>fun_class</code>, and follow the same naming convention if a new file is needed;
-- In case of a new file, add it at the end of <code>index.rst</code>;
-- Install <code>sphinx</code> and <code>numpydoc</code>;
-  - Run <code>docs_gen.sh</code> inside the <code>docs</code> folder (the variable `SPHINXBUILD` in the `Makefile` should be probably changed), and check the result file <code>_build/html/index.html</code>.
+The variable `SPHINXBUILD` in the `Makefile` depends on the particular user's system and should be probably changed.
 
 For any problem with the documentation, open an issue with tag <code>documentation</code>.

README.md

@@ -1,4 +1,4 @@
-# fathon [![Build Status](https://travis-ci.org/stfbnc/fathon.svg?branch=master)](https://travis-ci.org/stfbnc/fathon) [![Build status](https://ci.appveyor.com/api/projects/status/tl2a8c84bbvxu37p?svg=true)](https://ci.appveyor.com/project/stfbnc/fathon)
+# fathon [![Build Status](https://travis-ci.com/stfbnc/fathon.svg?branch=master)](https://travis-ci.com/stfbnc/fathon) [![Build status](https://ci.appveyor.com/api/projects/status/tl2a8c84bbvxu37p?svg=true)](https://ci.appveyor.com/project/stfbnc/fathon)
 
 [![Issues](https://img.shields.io/github/issues-raw/stfbnc/fathon.svg?maxAge=25000)](https://github.com/stfbnc/fathon/issues) [![GitHub stars](https://img.shields.io/github/stars/stfbnc/fathon.svg?style=social&label=Stars&style=plastic)]() [![GitHub forks](https://img.shields.io/github/forks/stfbnc/fathon.svg?style=social&label=Fork&style=plastic)]() [![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/)
 
@@ -62,10 +62,14 @@ Bianchi, S., (2020). fathon: A Python package for a fast computation of  detrend
 
 ## Version  [![PyPI version](https://badge.fury.io/py/fathon.svg)](https://badge.fury.io/py/fathon)
 
-fathon v1.3
+fathon v1.3.1
 
 ## Changelog
 
+#### v1.3.1
+
+- faster algorithms
+
 #### v1.3
 
 - <code>MFDCCA</code> algorithm

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= "/anaconda3/bin/sphinx-build"
+SPHINXBUILD   ?= "/opt/anaconda3/envs/fathon-env/bin/sphinx-build"
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: db3f5bea255d2777e941c20da7e7babc
+config: f90c25076383ba83e2a381309ccdd14a
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/index.rst.txt

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-fathon (v1.3)
+fathon (v1.3.1)
 ***************
 
 Current version is available for Linux (x86_64 and ARM64), macOS, and Windows (64bit).