alsgregory / FADE

Firedrake and Assimilating Data using Ensembles (FADE)
MIT License
2 stars 0 forks source link

FADE

A toolbox of ensemble based data-assimilation algorithms for use with Firedrake.

Linux terminal installation

As a prerequisite, it is required to have Firedrake installed alongside it's dependencies. Instructions on how to this can be found at: http://firedrakeproject.org/download.html. Then, it is required to have the Firedrake virtualenv activated; instructions for this can be found by again following the aforementioned link.

Finally, for some demos to work it is required to have Firedrake-MLMC installed (a side-package of http://firedrakeproject.org). Instructions on how to do this can be found at: https://github.com/firedrakeproject/firedrake-mlmc.

Then, to install firedrake_da, type the following commands into the terminal:

  1. git clone https://github.com/firedrake_da
  2. pip install -e ./firedrake_da

Documentation

To build the documentation, type

make html

whilst in the docs repository, or alternatively go to

Documentation Status

Contact

For any enquiries, please contact: a.gregory14@imperial.ac.uk

Author Details

Mr. Alastair Gregory, Research Postgraduate, Imperial College London

References and Acknowledgements

The C code for the Earth Mover's Distance computations in this package, used to create kernels for Firedrake is from the following reference: Y. Rubner, C. Tomasi, and L. J. Guibas. The earth mover’s distance as a metric for image retrieval. IJCV, 2000.

I would like to thank Dr. Colin Cotter and the Firedrake team at Imperial College London for help in designing and developing this open source package.