Skip to content

Commit

Permalink
fixed docs #39
Browse files Browse the repository at this point in the history
  • Loading branch information
timueh committed Sep 18, 2020
1 parent 67bb77a commit 9896d0b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 18 deletions.
18 changes: 9 additions & 9 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc"
SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"

[compat]
AbstractTrees = "0.2, 0.3"
DifferentialEquations = "6"
Documenter = "0.22, 0.24"
GR = "0.40, 0.46"
JuMP = "0.19, 0.20"
AbstractTrees = "0.3"
DifferentialEquations = "6.15"
Documenter = "0.24"
GR = "0.46"
JuMP = "0.20"
LaTeXStrings = "1.0"
MosekTools = "0.7, 0.9"
Plots = "0.25, 0.29"
QuadGK = "2"
SpecialFunctions = "0.7, 0.8, 0.10"
MosekTools = "0.9"
Plots = "0.29"
QuadGK = "2.4"
SpecialFunctions = "0.10"
26 changes: 17 additions & 9 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ However, a cornerstone principle of PolyChaos is to provide all the functionalit
- a replacement for [FastGaussQuadrature.jl](https://github.com/ajt60gaibb/FastGaussQuadrature.jl)

## Installation
The package requires `Julia 1.0` or newer.
The package requires `Julia 1.3` or newer.
In `Julia` switch to the package manager
```julia
julia> ]
(v1.0) pkg> add PolyChaos
(v1.03 pkg> add PolyChaos
```
This will install PolyChaos and its dependencies.
Once that is done, load the package:
Expand Down Expand Up @@ -103,13 +103,21 @@ If you found the software useful and applied it to your own research, we'd appre
Add the following to your BibTeX file
```tex
@misc{Muehlpfordt18,
author = {T. Mühlpfordt and F. Zahn and F. Becker and T. Faulwasser and V. Hagenmeyer},
title = {PolyChaos.jl -- A Julia package for orthogonal polynomials, quadrature, and polynomial chaos expansion},
year = 2019,
doi = {10.5281/zenodo.2592031},
url = {https://doi.org/10.5281/zenodo.2592031}
@ARTICLE{2020arXiv200403970M,
author = {{M{\"u}hlpfordt}, Tillmann and {Zahn}, Frederik and {Hagenmeyer}, Veit and
{Faulwasser}, Timm},
title = "{PolyChaos.jl -- A Julia Package for Polynomial Chaos in Systems and Control}",
journal = {arXiv e-prints},
keywords = {Electrical Engineering and Systems Science - Systems and Control, Mathematics - Numerical Analysis, Mathematics - Optimization and Control},
year = 2020,
month = apr,
eid = {arXiv:2004.03970},
pages = {arXiv:2004.03970},
archivePrefix = {arXiv},
eprint = {2004.03970},
}
```
Of course you are more than welcome to partake in GitHub's gamification aka :star: and :fork_and_knife:.
Of course you are more than welcome to partake in GitHub's gamification: starring and forking is much appreciated.
Enjoy.

0 comments on commit 9896d0b

Please sign in to comment.