From a6e3bef034c6ec849bf4700ce8e251b70286a98b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mos=C3=A8=20Giordano?= Date: Sat, 18 May 2019 22:07:41 +0100 Subject: [PATCH] Mention that correlation matrices are not yet supported Fix #41. --- README.md | 6 +++--- docs/src/index.md | 5 ++++- docs/src/todo.md | 6 ++++++ 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1fc33aff..d1a0233d 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,6 @@ easy-to-use calculator. automatic differentiation, and much more. * Integration with [`Plots.jl`](https://github.com/JuliaPlots/Plots.jl). -Further features are expected to come in the future, see the section "How Can I -Help?" and the TODO list below. - The method used to handle functional correlation is described in this paper: * M. Giordano, 2016, "Uncertainty propagation with functionally correlated @@ -79,6 +76,9 @@ The method used to handle functional correlation is described in this paper: (Bibcode: [`2016arXiv161008716G`](http://adsabs.harvard.edu/abs/2016arXiv161008716G)) +A current limitation of the package is that it is not yet possible to define +quantities related by a correlation matrix. + If you use use this package for your research, please cite it. ### Documentation ### diff --git a/docs/src/index.md b/docs/src/index.md index 5f1a1094..94dbf1b2 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -67,6 +67,9 @@ The main features of the package are: differentiation, and much more. - Integration with [Plots.jl](https://github.com/JuliaPlots/Plots.jl). +A current limitation of the package is that it is not yet possible to define +quantities related by a correlation matrix. + ## Citation and license The method used to handle functional correlation is described in this paper: @@ -81,7 +84,7 @@ convience, a BibTeX entry is provided in the file. Other features are expected to come in the future, see the [How Can I -Help?](@ref) section. +Help?](@ref) section and the [TODO](@ref) list. The `Measurements.jl` package is licensed under the MIT "Expat" License. The original author is Mosè Giordano. diff --git a/docs/src/todo.md b/docs/src/todo.md index 39163877..9cca922d 100644 --- a/docs/src/todo.md +++ b/docs/src/todo.md @@ -5,6 +5,12 @@ The package is developed at https://github.com/JuliaPhysics/Measurements.jl. There you can submit bug reports, make suggestions, and propose pull requests. +TODO +---- + +* Allow defining quantities related by a correlation matrix and correctly + propagate uncertainty in this case + How Can I Help? ---------------