Skip to content

Commit

Permalink
Mention that correlation matrices are not yet supported
Browse files Browse the repository at this point in the history
Fix #41.
  • Loading branch information
giordano committed May 18, 2019
1 parent 954de41 commit a6e3bef
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,16 @@ 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
quantities", [arXiv:1610.08716](http://arxiv.org/abs/1610.08716)
(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 ###
Expand Down
5 changes: 4 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
6 changes: 6 additions & 0 deletions docs/src/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
---------------

Expand Down

0 comments on commit a6e3bef

Please sign in to comment.