Skip to content
Snippets Groups Projects
Commit 01c35cc1 authored by Stéphane Adjemian's avatar Stéphane Adjemian
Browse files

Initial commit.

parents
No related branches found
No related tags found
No related merge requests found
*~
*.mat
doc/build/*
\ No newline at end of file
The Dynare particles module is distributed under the GNU GPL:
> Copyright © 2014 Dynare Team <dev@dynare.org>
>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU General Public License as published by
> the Free Software Foundation, either version 3 of the License, or
> (at your option) any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU General Public License for more details.
>
> You should have received a copy of the GNU General Public License
> along with this program. If not, see <http://www.gnu.org/licenses/>.
\ No newline at end of file
# particless Dynare module
This package, used in [Dynare](http://www.dynare.org), provides
nonlinear filtering algorithmss. The documentation is available in the
[doc](https://github.com/DynareTeam/particles/tree/master/doc)
subfolder.
\ No newline at end of file
# Documentation for particles Dynare module
The documentation is written with sphinx, so you need to have
[Python](https://www.python.org/) on your system with
[sphinx](http://sphinx-doc.org/). You also need to install the [Read
the docs](https://readthedocs.org/) theme and the sphinx matlab
domain, this can be done with pip in a terminal:
```
~$ pip install sphinx_rtd_theme
~$ pip install sphinxcontrib-matlab
```
To obtain the documentation as an html file in subfolder
```build/html``` you just have to use the provided Makefile:
```
~$ make html
```
\ No newline at end of file
#+STARTUP: overview
#+STARTUP: hidestars
#+AUTHOR: Stéphane Adjemian
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment