Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ARTime README.md #399

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion nab/detectors/ARTime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

This detector is maintained in a separate GitHub repository [ARTimeNAB](https://github.com/markNZed/ARTimeNAB.jl) and was developed in the Julia programming language.

To run this detector you must install the [JuliaCall](https://github.com/cjdoris/PythonCall.jl) module which is in requiremetns.txt in this directory, it can be installed using pip: `pip install -r requirements.txt`
To run this detector you must install the [JuliaCall](https://github.com/cjdoris/PythonCall.jl) Python module which is in requirements.txt in this directory, it can be installed using pip: `pip install -r requirements.txt`

This Python wrapper for ARTime will use JuliaCall to install Julia and the ARTime Julia package, when the ARTime detector is run using NAB.

JuliaCall will default to installing the latest stable version of Julia (ignoring the Julia version in the juliacalldeps.json file at the root of NAB). ARTime is no longer compatible with the most recent Julia language. To use Julia 1.7.0 with JuliaCall you must install Julia 1.7.0 and set the environment variable: PYTHON_JULIACALL_EXE to the Julia 1.7.0 binary executable before running the ARTime detector.

From the root of NAB run the ARTime detector with: `python run.py -d ARTime --detect --optimize --score --normalize --skipConfirmation`