Skip to content

Commit 5a26df0

Browse files
Add Installation and Contributing sections (#63)
1 parent b03a49d commit 5a26df0

File tree

2 files changed

+12
-31
lines changed

2 files changed

+12
-31
lines changed

README.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,4 @@
1010
[codecov-img]: https://codecov.io/gh/LAMPSPUC/GAS.jl/coverage.svg?branch=master
1111
[codecov-url]: https://codecov.io/gh/LAMPSPUC/GAS.jl?branch=master
1212

13-
GAS.jl is a Julia package for modeling, forecasting and simulating time series with score-driven models, also known as dynamic conditional score models (DCS) or generalized autoregressive score models (GAS). Implementations are based on the paper [Generalized Autoregressive Models with Applications](http://dx.doi.org/10.1002/jae.1279) by D. Creal, S. J. Koopman and A. Lucas.
14-
15-
# Features
16-
* Autoregressive structure
17-
* Maximum likelihood estimation
18-
* Monte Carlo simulation
19-
* General link/unlink interface
20-
* Available distributions:
21-
* Normal
22-
* Lognormal
23-
* Poisson
24-
* Beta
25-
* Gamma
26-
27-
# Roadmap
28-
* Weibull distribution
29-
* Student's t distribution
30-
* Dynamic components structure
13+
GAS.jl is a Julia package for modeling, forecasting and simulating time series with score-driven models, also known as dynamic conditional score models (DCS) or generalized autoregressive score models (GAS). Implementations are based on the paper [Generalized Autoregressive Models with Applications](http://dx.doi.org/10.1002/jae.1279) by D. Creal, S. J. Koopman and A. Lucas.

docs/src/index.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@
22

33
GAS.jl is a Julia package for modeling, forecasting and simulating time series with or generalized autoregressive score models (GAS) models, also known as dynamic conditional score models (DCS). Implementations are based on the paper [Generalized Autoregressive Models with Applications](http://dx.doi.org/10.1002/jae.1279) by D. Creal, S. J. Koopman and A. Lucas.
44

5-
# Features
6-
* SARIMA structure
7-
* Maximum likelihood estimation
8-
* Monte Carlo simulation
9-
* Several available distributions:
10-
* Normal
11-
* Lognormal
12-
* Poisson
13-
* Beta
14-
* Gamma
5+
## Installation
156

16-
# Roadmap
17-
* Weibull distribution
18-
* Unobserved components structure
7+
This package is not yet registered so you can `Pkg.add` it as follows:
8+
```julia
9+
pkg> add https://github.com/LAMPSPUC/GAS.jl.git
10+
```
11+
12+
## Contributing
13+
14+
Contributions to this package are more than welcome, if you find a bug or have any suggestions for the documentation please post it on the [github issue tracker](https://github.com/LAMPSPUC/GAS.jl/issues).
15+
16+
When contributing please note that the package follows the [JuMP style guide](https://www.juliaopt.org/JuMP.jl/stable/style/).

0 commit comments

Comments
 (0)