Getting Started

Python dependencies

We have a dependency on the package scikit-learn, please first install this from here

https://scikit-learn.org/stable/install.html#installation-instructions

If you are installing in a non-default environment you may have to give this environment path to PyCall on first running of the package.

The first time you use the package

Clone the repository, and enter the root directory. Open julia REPL by typing

julia --project

Then instantiate the package with the package manager

]
instantiate
<Backspace>

Testing the package

We have a test suite to make sure the package is correctly configured. To run the suite, open the julia REPL and type:

using Test
include("test/runtests.jl")

If all pass then all of the package pieces should work!

Using the Examples

Examples in the repository may have their own project dependencies. Navigate to the root directory examples/example_name and open the Julia REPL with

julia --project

instantiate the example packages/dependencies with

]
instantiate
<Backspace>

If you are developing, or have an CalibrateEmulateSample error instantiating, you may wish to change the CalibrateEmulateSample package to a local development package

]
rm CalibrateEmulateSample
dev /path/to/CalibrateEmulateSample.jl/
<Backspace>

To run an example one can then use

include("XYZ_example.jl")