laura7089 / tealeaf.jl

Julia port of the TeaLeaf heat equation code

TeaLeaf.jl

This is a port of TeaLeaf to the Julia Programming Language. It was ported from this C implementation of TeaLeaf. See the issues tab for an idea of the status of the project.

Usage

The code is intended to use the same configuration file format as other TeaLeaf implementations; an example configuration fileset (tea.in, tea.problems) is provided.

Running

Using just

Using just is the recommended way to run the program.

just run will run the program with the default parameters. To see more options, see the output of just -l.

Manually

There are a handful of options for running the program manually:

• It can be run straight from this directory using the quick-run script with julia --project ./run.jl. Extra CLI args can be appended with -- --extra-arg. See julia --project ./run.jl -- --help for options.
• It can be run from the Julia REPL started with julia --project (see the documentation for this).

Documentation

Licensing

All original code in this repo is licensed under the Apache license.

tealeaf.jl's Issues

Write `Documenter.jl` doc

Mathematical results are inconsistent

The project has trouble returning the same results as the original implementations. This obviously needs fixing.