baeda-polito / matrix-profile Goto Github PK

Update the main entrypoint so it can receive two arguments:

• The input dataset via an HTTP URL. The tool should then download the dataset from that URL; since it's a presigned URL, the tool would not need to deal with authentication—it can just download the dataset directly.
• The local path to the output HTML report. The platform would then get that HTML report and upload it to the object storage service for the user to review later.

For example:

$ python -m src.cmp.main --input https://presigned-download-url.com --output /tmp/output.html
⬇️ Downloading file from https://presigned-download-url.com
... [Execution logs] ... 
🎉 Report generated sucessfully on /tmp/output.html

If the tool fails for any reason, the platform would capture the error output and present it to the user. The following is an example of how the tool could show the errors:

$ python -m src.cmp.main --input https://presigned-download-url.com --output /tmp/output.html
🔴 The execution failed due to the following reasons:
* Reason 1
* Reason 2
* ...

It would be nice if we could create a fork to mirror this repository in MODERATE's GitHub organization. That way, all the software projects of MODERATE would be available in the same catalogue, which would be much simpler for external users.

For example, we have already done something similar with LINKS' Cybersecurity-LINKS/trust-service, which has been forked into its own repository MODERATE-Project/trust-service.

Furthermore, this would greatly simplify integration with the Continuous Integration pipeline that builds the Docker images and publishes them to MODERATE's private registry.

We should write documentation so that end users who are not familiar with the tool can learn the basic concepts to use it. For example:

• What does the tool do?
• What's the main interface of the tool?
• What are the accepted input dataset formats? What columns should be included? What's the minimum time series interval for the tool to function?

The documentation could be added to the current repository as Markdown files. We would then copy it to the MODERATE Documentation site. Another option would be to push it directly to MODERATE's documentation repository.