/Comp-Engine-Features

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Comp-Engine-Features

DOI

Comp-Engine-Features is a web platform that compares a user's time-series analysis algorithm (python) and compares its behavior to that of a library of >7000 existing algorithms from hctsa.

See CompEngine for an analogous living library of time-series data.

To setup and run on localhost:

  1. Clone the repository.
  2. Install all the required packages mentioned in requirements.txt
   pip install -r requirements.txt
  1. In settings.pymake the following changes:
   Debug=True
   Allowed_hosts=[]
  1. Create .env file in the project's root directory and add the secret key in it.
SECRET_KEY= "Add 50 characters long string by combination of
             digits,characters,special characters and symbols"
  1. Run the app
   python manage.py runserver

How to use :

To use Comp-Engine-Features:

  1. Create a .py file containing analysis method coded in python (structure of the code is mentioned in HowItWorks page. )

  2. Submit the function name and the .py file on the form given on home page.

  3. Get the results.

You can also download all the best matching results in .csv format.


Contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.