prepare readme and docs for deprecation

CONTRIBUTING.md

@@ -1,54 +1,6 @@
 # Contributing to pyWATTS
 
-:+1::tada: First, thanks for taking the time to contribute! :tada::+1:
-
-## How Can I Contribute?
-
-### Reporting Bugs
-
-This section guides you through submitting a bug report for pyWATTS. 
-
-Before creating bug reports, please check if the bug is already reported in the issues. If you create a bug report or issue, please fill out the provided template and add as much information as possible for reproducing the bug.
-
-#### Before Submitting A Bug Report
-
-* Check if you are able to reproduce the bug in the newest pyWATTS version.
-* Search in the issue list to see if the problem is already reported. If there exists an **open** issue add further details to the issue if possible. If there is a **closed** issue please create a **new** issue.
-
-#### Submitting A Good Bug Report?
-
-Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). 
-
-Explain the problem and include additional details to help maintainers reproduce the problem:
-
-* Use a title that identifies the problem.
-* Describe the steps for reproducing the problem. You can add specific examples if you like.
-* Describe the behaviour you observed and the behaviour you would expect.
-
-Include details about your configuration and environment:
-
-* Which version of pyWATTS are you using.
-* If it seems to be connected to a third-party library please add the version of the third-party library.
-
-### Suggesting Enhancements
-
-This section guides you through submitting an enhancement suggestion for pyWATTS, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
-
-Before creating enhancement requests, please check if such an enhancement is already suggested in the issue list. If you suggest an enhancement, please fill out the provided template.
-
-#### Before Submitting An Enhancement Suggestion
-
-* *Check if there is already an issue that suggests the enhancement
-
-#### Submitting An (Good) Enhancement Suggestion?
-
-Enhancement suggestions are tracked as [GitHub issues]
-
-* Use a title for the issue that identifies the suggestion.
-* Explain the suggested enhancement step-by-step and in detail.
-* If you suggest a new module, provide a small example with the expected input and the desired output.
-* Explain the usefullness of the enhancement
-
-### Pull Requests
-
-If your code is ready, please create a pull request and fill in the template. Afterwards, verify that all checks are passed. Then a maintainer will review the PR.
+pyWATTS is no longer maintained. The graph pipeline functionality of pyWATTS has been 
+integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/),
+so if you wish to use this feature and contribute code we suggest you
+contribute to [sktime](https://www.sktime.net/en/stable/).

README.md

@@ -3,7 +3,18 @@
 [![Documentation](https://readthedocs.org/projects/pywatts/badge/)](https://pywatts.readthedocs.io/en/latest/)
 
 
-# pyWATTS
+# pyWATTS - Now Deprecated
+
+**Please note that pyWATTS is no longer actively maintained. Therefore, the contents of this repository are now read-only!**
+
+**The graph pipeline functionality of pyWATTS has now been integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/).**
+
+We would like to thank everybody who has helped develop, test, and use pyWATTS in the last few years and strongly advise all past pyWATTS users to apply [sktime](https://www.sktime.net/en/stable/) in the future.
+
+
+# Legacy Instructions for Use
+
+If you still wish to use pyWATTS you can follow the legacy instructions below.
 
 ## Installation
 
@@ -247,22 +258,7 @@ For a common understanding of the various terms used in this framework, see the
 
 ## Current Development Status
 
-### Standing assumptions
-
-* The graph representing the pipeline is a directed acyclic graph (DAG).
-* The first coordinate is always the time coordinate.
-
-### Known issues* Currently, no edge cases are tested.
-
-* Currently, no pipeline checks are implemented.
-* Currently, the biclustering mixin of sklearn is not supported.
-* Currently, subpipelining is only possible if the outer pipeline does use online learning.
-
-### Outlook on further features
-
-* Grid search to find the best combination of preprocessing and models
-* Online/Batch Learning (partially, see known issues)
-* Multiprocessing
+**PyWATTS is no longer maintained and therefore deprecated**
 
 # Funding
 
@@ -273,6 +269,3 @@ If you use this framework in a scientific publication please cite the correspond
 
 >Benedikt Heidrich, Andreas Bartschat, Marian Turowski, Oliver Neumann, Kaleb Phipps, Stefan Meisenbacher, Kai Schmieder, Nicole Ludwig, Ralf Mikut, Veit Hagenmeyer. “pyWATTS: Python Workflow Automation Tool for Time Series.” (2021). ). arXiv:2106.10157. http://arxiv.org/abs/2106.10157
 
-# Contact
-If you have any questions and want to talk to the pyWATTS Team directly, feel free to [contact us](mailto:pywatts-team@iai.kit.edu).
-For more information on pyWATTSvisit the [project website](https://www.iai.kit.edu/english/1266_4162.php).

docs/source/about_us.rst

@@ -1,34 +1,29 @@
 About us
 ========
 
+Note that pyWATTS is no longer actively maintained
+
+
 History
 -------
 This project was started in 2019 by the Research Group "Machine Learning for Time Series and Images" of the Institute for
 Automation and Applied Informatics at the Karlsruhe Institute of Technology.
 
-For more information on pyWATTS you can visit https://www.iai.kit.edu/english/1266_4162.php
+pyWATTS is no longer actively maintained, however the main graph pipeline functionality of pyWATTS has been
+integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/).**
 
-Active Contributors
--------
-The following people are currently involved in pyWATTS' core development and maintenance:
+Contributors
+--------------
+The following people actively contributed to pyWATTS during its development and use:
 
 * Benedikt Heidrich
-* Stefan Meisenbacher
+* Andreas Bartschat
+* Marian Turowski
 * Oliver Neumann
 * Kaleb Phipps
-
-Please do not contact the authors directly to ask for assistance or report issues. Instead, please send an e-mail to us:
-pywatts-team@iai.kit.edu
-
-See also: :ref:`contribution`.
-
-Former Contributors
---------------
-The following people have been active contributors in the past, but are no longer active in the project:
-
-* Andreas Bartschat
+* Stefan Meisenbacher
 * Nicole Ludwig
-* Marian Turowski
+
 
 Citing pyWATTS
 --------------

docs/source/contribution.rst

@@ -3,75 +3,8 @@
 How to Contribute
 =================
 
-Great to have you here! The best way to get involved is by starting to use pyWATTS.
-We also happily welcome you if you're interested in contributing with new feature ideas,
-filing bug reports or contributing your own modules.
+pyWATTS is no longer maintained. The graph pipeline functionality of pyWATTS has been
+integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/),
+so if you wish to use this feature and contribute code we suggest you
+contribute to [sktime](https://www.sktime.net/en/stable/).
 
-Report a bug or request a feature
----------------------------------
-You have found a bug or you are missing a great feature? Great!
-We track our bugs and feature ideas with GitHub issues; feel free to open an issue if you encounter a bug or have a
-feature that you would like to see implemented in the future.
-
-Before you open a new issue, please check that it is not already addresses by any other issues or pull requests.
-
-If you are *submitting a bug report*, please make sure you include the following information
-
-- ideally, a short reproducible code snippet,
-- if you can not provide a code snippet, please provide detailed and precise information about the problem,
-  so that we can recreate it ourselves (what are you trying to do, what functions are involved, what type of data are
-  you using, what are the dimension of this data, etc.)
-- your operating system type and version number, as well as your Python,
-  scikit-learn, numpy, and scipy versions
-- the full traceback, if an exception is raised.
-
-If you are *requesting a feature*, it would help us a lot if you include the following information
-
-- a detailed description of the feature (ideally with an example)
-- how you expect the input and output of the module to look like (optional)
-
-If you encounter any issues when using pyWATTS feel free to contact us.
-
-Work on known issues
---------------------
-
-To start working on an issue, please assign the issue to yourself and
-create a new branch. We have three categories
-
-- docs
-- bugfix
-- feature
-
-and request that you follow our naming convention with your branch name:
-
-.. code-block::
-
-  category/[issue number]_[short name of issue]
-
-For example:
-
-.. code-block::
-
-  docs/102_naming_conventions
-
-Before working on the issue, read carefully through our programming guidelines, tests, and documentation information
-(:ref:`gettingstarted` and :ref:`howtouse`). Please follow our guidelines when coding, as this helps us with the review process and
- allows us to integrate your work into pyWATTS much faster. Moreover, you should update the CHANGELOG.md. Therefore,
-add at the top the name of your pull request as a title. Afterwards, list the features you have implemented.
-
-Write your own modules
-----------------------
-
-We always welcome new contributions to pyWATTS and therefore, if you want to write your own module or have already done
-so, feel free to share it with the pyWATTS community. Before starting, make sure this isn't already an open issue, if
-in doubt about duplicated work feel free to contact us. To avoid double ups, please let us know what your plans are by
-opening an issue.
-
-Before working on the module, read carefully through our programming guidelines, tests, and documentation information
-(:ref:`gettingstarted` and :ref:`howtouse`).  Please follow our guidelines when coding, as this helps us with the review process and
- allows us to integrate your work into pyWATTS much faster. Moreover, you should update the CHANGELOG.md. Therefore,
-add at the top the name of your pull request as a title. Afterwards, list the features you have implemented.
-
-Once you are happy with your module, feel free to issue a pull request. Every line of pyWATTS code (including our own)
-is reviewed by a second person. If we find any issues then we will contact you with feedback, otherwise your module
-will be incorporated into our repository after approval.

docs/source/core.rst

@@ -1,6 +1,10 @@
 Core
 =====
 
+Note that pyWATTS is no longer actively maintained, however the main graph pipeline functionality of pyWATTS has been
+integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/).**
+
+
 Basic Idea
 ----------
 The main goal of pyWATTS is to automate the time series analysis workflow.

docs/source/getting_started.rst

@@ -3,7 +3,11 @@
 Getting Started
 ===============
 
+Note that pyWATTS is no longer actively maintained, however the main graph pipeline functionality of pyWATTS has been
+integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/).**
 
+Further Information
+*******************
 The purpose of this guide is to introduce some of the main features of `pyWATTS`.
 It assumes a basic knowledge of data science and machine learning principles.
 

docs/source/how_to_use.rst

@@ -3,6 +3,9 @@
 How to use?
 ===========
 
+Note that pyWATTS is no longer actively maintained, however the main graph pipeline functionality of pyWATTS has been
+integrated into the open source python pacakge [sktime](https://www.sktime.net/en/stable/).**
+
 Where should pyWATTS be used?
 -----------------------------
 pyWATTS is not a machine learning framework or library. Instead, pyWATTS' aim is to support users in performing data analysis tasks and hereby to avoid a script nightmare.