Skip to content

Commit

Permalink
amend README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nluetts committed Jul 8, 2021
1 parent 6eec467 commit 0af80f3
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 7 deletions.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# NoisySignalIntegration.jl

*A tool to determine uncertainty in numeric integrals of noisy data.*
*A tool to determine uncertainty in numeric integrals of noisy x-y data.*

`NoisySignalIntegration` implements a method to determine the uncertainty in
numeric integrals of noisy x-y data on the basis of a Monte-Carlo process. It
can include uncertainty due to noise, baseline subtraction, and placement in
integration bounds. To do this, the integration is repeated many times while
the noise of the data, baseline, and integration bounds are varied based on a
noise model and user supplied probability distributions.

To view the documentation, click the badge below:

[![Documentation, latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://nluetts.github.io/NoisySignalIntegration.jl/dev/)

Expand All @@ -14,6 +23,14 @@ To install it for your project, enter the package mode in the Julia REPL (press
add https://github.com/nluetts/NoisySignalIntegration.jl
```

While still in package mode, you can type

```
test NoisySignalIntegration
```

to run the package's unit tests.

## Getting Started

Check out the [documentation](https://nluetts.github.io/NoisySignalIntegration.jl/dev/) to learn how to use the package.
Expand Down
17 changes: 11 additions & 6 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# NoisySignalIntegration.jl

*NoisySignalIntegration.jl -- A tool to determine uncertainty in numeric
integrals of noisy data.*
integrals of noisy x-y data.*

`NoisySignalIntegration` implements a method to determine the uncertainty in
numeric integrals of noisy data on the basis of a Monte-Carlo process. A
predecessor of this package was originally intended to estimate uncertainties of
band signals in FTIR spectra (see [G. Karir et al.,
numeric integrals of noisy x-y data on the basis of a Monte-Carlo process. It
can include uncertainty due to noise, baseline subtraction, and placement in
integration bounds. To do this, the integration is repeated many times while
the noise of the data, baseline, and integration bounds are varied based on a
noise model and user supplied probability distributions.

A predecessor of this package was originally intended to estimate uncertainties
of band signals in FTIR spectra (see [G. Karir et al.,
2019](https://doi.org/10.1039/C9CP00435A)), which is reflected in the example
given in the usage guide.
given in the [Usage Guide](@ref).

**Table of Contents**

```@contents
Pages = ["overview.md", "guide.md", "examples.md", "baseline.md", "API.md", "internals.md"]
Depth = 4
```
```
8 changes: 8 additions & 0 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,12 @@ To install it for your project, enter the package mode in the Julia REPL (press
add https://github.com/nluetts/NoisySignalIntegration.jl
```

While still in package mode, you can type

```
test NoisySignalIntegration
```

to run the package's unit tests.

Note that the package requires Julia v1.5 or above.

0 comments on commit 0af80f3

Please sign in to comment.