Full documentation

TaylorGenerator(name=randstring(12), eqs_filename, parent_path=".")

Structure used to generate directories and call taylor. The directory name will be $(parent_path)/taylor_$(name). The equation file should follow the syntax required by taylor.

TaylorHandler(path)

Structure used to open, use and close directories generated by TaylorGenerator.

generate_dir(generator, silent=false)

Generates the directory corresponding to the generator, and builds the library. If silent is true, command will be silent apart from errors.

get_taylor_dir(generator)

Returns the directory associated to the generator.

get_handler(generator, open=true)

Get the TaylorHandler corresponding to the generator. If open is true, the library will also be open in the handler.

compile_eqs(generator, silent=false)

Runs make in the directory of the generator. If silent is true, runs make -s, thus being silent (apart from errors).

compile_eqs(handler, silent=false)

Runs make in the directory of the handler. If silent is true, runs make -s, thus being silent (apart from errors).

open_lib(handler)

Opens the handler's library, storing the loaded library and a dictionary with symbols to functions in the handler.

Currently, the loaded functions are flow, tstep and tstep_reverse.

close_lib(handler)

Close the library referred by the handler.

clear_dir(handler)

Delete the directory referred by the handler.

clear_dir(generator)

Delete the directory referred by the generator.

is_open(handler)

Check if handler refers to an open library.

check_open(handler)

Check if handler refers to an open library, and opens it if not.

flow!(han, x, [y], t, df=Ref(nothing))

Wrapper function around the C flow function in the han TaylorHandler.

df should be passed as a vector if jet transport is used. In this case, jet transport results will be stored in df.

If y is passed, the flow result will be stored in it.

flow(han, x, t)

Wrapper function around the C flow function in the han TaylorHandler. Should only be used if jet transport isn't used; otherwise, use flow!.

get_model(name, open=false)

Get the TaylorHandler corresponding to a default model in this package. If open is true, the library will also be open in the handler.

Warning: name should NOT contain the prefix "taylor_h".

get_dir_src()

Returns the directory containing this package.

get_models_dir()

Returns the directory containing predefined models.

get_wrappers(generator)

Get the appropriate wrapper files for the generator.

get_jet_flag(generator)

Get the jet flag to pass to taylor when compiling the equations given by the generator.