Compare revisions

variables:

  GIT_SUBMODULE_STRATEGY: recursive

  TERM: linux

  MATLAB_VERSION: R2021a

  MATLAB_VERSION: R2023b

  OLD_MATLAB_VERSION: R2014a

  OCTAVE_VERSION: 6.3.0

# The next stanza creates the version number used for the source tarball and the

# binary packages. Here are the following possible cases:

# - if VERSION was already set (when manually running a pipeline), use it

# - if we are in the official Dynare repository:

#   + if on a tag: use the tag

#   + if on master: use 4.7-unstable-$TIMESTAMP-$COMMIT

#   + on another branch: use $BRANCH-$TIMESTAMP-$COMMIT

#   + otherwise: use $BRANCH-$TIMESTAMP-$COMMIT

# - if in a personal repository: use $USER-$TIMESTAMP-$COMMIT

before_script:

  - '[[ -z $VERSION ]] && [[ $CI_PROJECT_NAMESPACE == Dynare ]] && [[ -n $CI_COMMIT_TAG ]] && export VERSION=$CI_COMMIT_TAG'

  - '[[ -z $VERSION ]] && [[ $CI_PROJECT_NAMESPACE == Dynare ]] && [[ $CI_COMMIT_REF_NAME == master ]] && export VERSION=4.7-unstable-$(date +%F-%H%M)-$CI_COMMIT_SHORT_SHA'

  - '[[ -z $VERSION ]] && [[ $CI_PROJECT_NAMESPACE == Dynare ]] && export VERSION=$CI_COMMIT_REF_NAME-$(date +%F-%H%M)-$CI_COMMIT_SHORT_SHA'

  - '[[ -z $VERSION ]] && export VERSION=$CI_PROJECT_NAMESPACE-$(date +%F-%H%M)-$CI_COMMIT_SHORT_SHA'

  - build

  - test

  - pkg

  - sign

  - deploy

build_binaries:

  stage: build

  script:

    - autoreconf -si

    - ./configure --with-matlab=/usr/local/MATLAB/$MATLAB_VERSION --with-octave=/usr/local/octave/$OCTAVE_VERSION PACKAGE_VERSION=$VERSION PACKAGE_STRING="dynare $VERSION"

    - ./configure --with-matlab=/opt/MATLAB/$MATLAB_VERSION PACKAGE_VERSION=$VERSION PACKAGE_STRING="dynare $VERSION"

    - make -j $(nproc) LN_S="cp -p"

  artifacts:

    paths:

    - rm doc/manual/source/_static/mathjax && sed -i "/^mathjax_path *=/d" doc/manual/source/conf.py

    - 'for f in configure.ac preprocessor/configure.ac mex/build/matlab/configure.ac mex/build/octave/configure.ac; do sed -i "s/^AC_INIT(\[\(.*\)\],\s*\[\(.*\)\])/AC_INIT([\1], [$VERSION])/" $f; done'

    - autoreconf -si

    - ./configure --with-matlab=/usr/local/MATLAB/$MATLAB_VERSION --with-octave=/usr/local/octave/$OCTAVE_VERSION

    - ./configure --with-matlab=/opt/MATLAB/$MATLAB_VERSION

    - make dist

  artifacts:

    paths:

pkg_windows:

  stage: pkg

  script:

    - ln -s ~/tarballs windows/deps/

    - mkdir -p windows/deps/tarballs && cp /usr/lib/dynare-runner/matlab64-* windows/deps/tarballs/

    - make -C windows

    - rm windows/deps/tarballs/matlab64-* # No need to cache these files

  cache:

    key: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"

    - key: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"

      paths:

        - windows/deps/sources64/

        - windows/deps/lib64/

        # We do not cache lib64-msys2, mingw64, octave64 and

        # matlab64, because those are simply extracted from a tarball. It

        # would be a waste of space and of (re-compression) time.

    - key: $CI_JOB_NAME

      # This cache is shared between all branches, to save space

      paths:

        - windows/deps/tarballs/

  artifacts:

    paths:

      - windows/exe/*

  stage: pkg

  script:

    - ln -s ~/tarballs macOS/deps/

    - make -C macOS

    - arch -x86_64 make -C macOS

  cache:

    key: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"

    paths:

  extends: .test_matlab_template

  script:

    - autoreconf -si

    - ./configure --disable-octave --with-matlab=/usr/local/MATLAB/$MATLAB_VERSION

    - ./configure --disable-octave --with-matlab=/opt/MATLAB/$MATLAB_VERSION

    - make -j $(($(nproc) * 3 / 4)) -C tests check-matlab

test_old_matlab:

  extends: .test_matlab_template

  script:

    - autoreconf -si

    - ./configure --disable-octave --with-matlab=/usr/local/MATLAB/$OLD_MATLAB_VERSION

    - ./configure --disable-octave --with-matlab=/opt/MATLAB/$OLD_MATLAB_VERSION

    - make -C mex/build/matlab clean

    - make -j $(nproc) -C mex/build/matlab

    - make -j $(($(nproc) * 3 / 4)) -C tests check-matlab

  when: manual

test_octave:

  stage: test

    OPENBLAS_NUM_THREADS: 1

  script:

    - autoreconf -si

    - ./configure --disable-matlab --with-octave=/usr/local/octave/$OCTAVE_VERSION

    - ./configure --disable-matlab

    - make -j $(nproc) -C tests check-octave

  artifacts:

    paths:

      - tests/run_test_octave_output.txt

    when: always

  needs: [ "build_binaries" ]

  when: manual

test_dynare++:

  stage: test

      - dynare++/tests/*.mat

      - dynare++/tests/*.dump

# For the deploy jobs, we don’t use the “needs” keyword, since we don’t want

# those jobs to start before the “test” and “pkg” stages have succeeded. Hence

# we stick to the “dependencies” keyword.

# For the sign and deploy jobs, we don’t use the “needs” keyword, since we

# don’t want those jobs to start before the “test” and “pkg” stages have

# succeeded. Hence we stick to the “dependencies” keyword.

deploy_manual_unstable:

sign_windows:

  stage: sign

  rules:

    - if: '$CI_PROJECT_NAMESPACE == "Dynare" && $CI_COMMIT_TAG =~ /^5\.[0-9]+$/'

      when: on_success

    - when: never

  tags:

    - sign

  dependencies:

    - pkg_windows

  script:

    - f=(windows/exe/*) && mkdir -p windows/exe-signed/ && osslsigncode sign -pkcs11module /usr/lib/x86_64-linux-gnu/libykcs11.so.2 -key "pkcs11:id=%01;type=private;pin-value=$YUBIKEY_PIN" -certs ~/cepremap-code-signing-comodo-sectigo.pem -n Dynare -i https://www.dynare.org -t http://timestamp.comodoca.com -in ${f[0]} -out windows/exe-signed/${f[0]##*/}

  artifacts:

    paths:

      - windows/exe-signed/*

    expire_in: 3 days

deploy_manual_stable:

  stage: deploy

  rules:

    - if: '$CI_PROJECT_NAMESPACE == "Dynare" && $CI_COMMIT_REF_NAME == "master"'

    - if: '$CI_PROJECT_NAMESPACE == "Dynare" && $CI_COMMIT_TAG =~ /^5\.[0-9]+$/'

      when: on_success

    - when: never

  tags:

    - restricted

    - deploy

  dependencies:

    - build_doc

  script:

    - rm -rf doc/manual/build/html/_static/mathjax

    - ln -s /usr/share/javascript/mathjax doc/manual/build/html/_static/mathjax

    - rsync --recursive --links --delete doc/manual/build/html/ /srv/www.dynare.org/manual-unstable/

    - rsync --recursive --links --delete doc/manual/build/html/ /srv/www.dynare.org/manual/

    - cp doc/manual/build/latex/dynare-manual.pdf /srv/www.dynare.org/manual.pdf

deploy_snapshot_unstable:

deploy_release_stable:

  stage: deploy

  rules:

    - if: '$CI_PROJECT_NAMESPACE == "Dynare" && $CI_COMMIT_REF_NAME == "master"'

    - if: '$CI_PROJECT_NAMESPACE == "Dynare" && $CI_COMMIT_TAG =~ /^5\.[0-9]+$/'

      when: on_success

    - when: never

  tags:

    - deploy

  dependencies:

    - pkg_source

    - pkg_windows

    - sign_windows

    - pkg_macOS

  script:

    - cp *.tar.xz /srv/www.dynare.org/release/source/

    - cp windows/exe-signed/* /srv/www.dynare.org/release/windows/

    - cp windows/7z/* /srv/www.dynare.org/release/windows-7z/

    - cp windows/zip/* /srv/www.dynare.org/release/windows-zip/

    - cp macOS/pkg/* /srv/www.dynare.org/release/macos/

    - ~/update-release-list.sh

    - curl -X POST -F token="$WEBSITE_PIPELINE_TRIGGER_TOKEN" -F ref=master https://git.dynare.org/api/v4/projects/40/trigger/pipeline

deploy_beta_stable:

  stage: deploy

  rules:

    - if: '$CI_PROJECT_NAMESPACE == "Dynare" && $CI_COMMIT_TAG =~ /^5(\.[0-9]+)?-(beta|rc)[0-9]+$/'

      when: on_success

    - when: never

  tags:

    - pkg_macOS

  script:

    - f=(windows/exe/*) && osslsigncode sign -pkcs12 ~/cepremap-comodo-sectigo-code-signing.p12 -n Dynare -i https://www.dynare.org -t http://timestamp.comodoca.com -in ${f[0]} -out ${f[0]}.signed && mv ${f[0]}.signed ${f[0]}

    - cp *.tar.xz /srv/www.dynare.org/snapshot/source/ && ln -sf *.tar.xz /srv/www.dynare.org/snapshot/source/dynare-latest-src.tar.xz

    - f=(windows/exe/*) && cp ${f[0]} /srv/www.dynare.org/snapshot/windows/ && ln -sf ${f[0]##*/} /srv/www.dynare.org/snapshot/windows/dynare-latest-win.exe

    - f=(windows/7z/*) && cp ${f[0]} /srv/www.dynare.org/snapshot/windows-7z/ && ln -sf ${f[0]##*/} /srv/www.dynare.org/snapshot/windows-7z/dynare-latest-win.7z

    - f=(windows/zip/*) && cp ${f[0]} /srv/www.dynare.org/snapshot/windows-zip/ && ln -sf ${f[0]##*/} /srv/www.dynare.org/snapshot/windows-zip/dynare-latest-win.zip

    - f=(macOS/pkg/*) && cp ${f[0]} /srv/www.dynare.org/snapshot/macos/ && ln -sf ${f[0]##*/} /srv/www.dynare.org/snapshot/macos/dynare-latest-macos.pkg

    - ~/update-snapshot-list.sh

    - curl -X POST -F token="$WEBSITE_PIPELINE_TRIGGER_TOKEN" -F ref=master https://git.dynare.org/api/v4/projects/40/trigger/pipeline

    - cp *.tar.xz /srv/www.dynare.org/beta/source/

    - cp windows/exe/* /srv/www.dynare.org/beta/windows/

    - cp windows/7z/* /srv/www.dynare.org/beta/windows-7z/

    - cp windows/zip/* /srv/www.dynare.org/beta/windows-zip/

    - cp macOS/pkg/* /srv/www.dynare.org/beta/macos/

[submodule "contrib/ms-sbvar/TZcode"]

	path = contrib/ms-sbvar/TZcode

	url = ../../contrib/TZcode.git

[submodule "contrib/dmm"]

	path = contrib/dmm

	url = ../../contrib/dmm.git

[submodule "matlab/utilities/tests"]

	path = matlab/utilities/tests

	url = ../../Dynare/m-unit-tests.git

# Dynare Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our

community a harassment-free experience for everyone, regardless of age, body

size, visible or invisible disability, ethnicity, sex characteristics, gender

identity and expression, level of experience, education, socio-economic status,

nationality, personal appearance, race, caste, color, religion, or sexual

identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,

diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our

community include:

* Demonstrating empathy and kindness toward other people

* Being respectful of differing opinions, viewpoints, and experiences

* Giving and gracefully accepting constructive feedback

* Accepting responsibility and apologizing to those affected by our mistakes,

  and learning from the experience

* Focusing on what is best not just for us as individuals, but for the overall

  community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of

  any kind

* Trolling, insulting or derogatory comments, and personal or political attacks

* Public or private harassment

* Publishing others' private information, such as a physical or email address,

  without their explicit permission

* Other conduct which could reasonably be considered inappropriate in a

  professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of

acceptable behavior and will take appropriate and fair corrective action in

response to any behavior that they deem inappropriate, threatening, offensive,

or harmful.

Community leaders have the right and responsibility to remove, edit, or reject

comments, commits, code, wiki edits, issues, and other contributions that are

not aligned to this Code of Conduct, and will communicate reasons for moderation

decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when

an individual is officially representing the community in public spaces.

Examples of representing our community include using an official e-mail address,

posting via an official social media account, or acting as an appointed

representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be

reported to the community leaders responsible for enforcement at

[community@dynare.org](mailto:community@dynare.org).

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the

reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining

the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed

unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing

clarity around the nature of the violation and an explanation of why the

behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of

actions.

**Consequence**: A warning with consequences for continued behavior. No

interaction with the people involved, including unsolicited interaction with

those enforcing the Code of Conduct, for a specified period of time. This

includes avoiding interactions in community spaces as well as external channels

like social media. Violating these terms may lead to a temporary or permanent

ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including

sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public

communication with the community for a specified period of time. No public or

private interaction with the people involved, including unsolicited interaction

with those enforcing the Code of Conduct, is allowed during this period.

Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community

standards, including sustained inappropriate behavior, harassment of an

individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the

community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],

version 2.1, available at

[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by

[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at

[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at

[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org

[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

[Mozilla CoC]: https://github.com/mozilla/diversity

[FAQ]: https://www.contributor-covenant.org/faq

[translations]: https://www.contributor-covenant.org/translations

   * `git remote add personal git@git.dynare.org:<<GitLab username>>/dynare.git`

1. Create a branch to work on

   * `git checkout -b <<descriptive branch name>>`

1. Do your work, all the while respecting the [Dynare Coding Standards](https://archives.dynare.org/DynareWiki/CodingStandards)

1. Do your work, all the while respecting the [Dynare Coding Guidelines](https://git.dynare.org/Dynare/dynare/-/wikis/CodingGuidelines)

1. You may also want to have a look at the [coding resources](https://git.dynare.org/Dynare/dynare/-/wikis/CodingResources)

As you work, your forked repository will likely fall out of sync with the main Dynare repository as we'll be working in parallel. No matter. Follow these steps to ensure your changes will be merge-able when they're done:

The output from the latest run of the test suite can be found in the `test_matlab` job associated to the [latest pipeline](https://git.dynare.org/Dynare/dynare/pipelines). This is also a good place to start fixing bugs. If you see a `.mod` file that doesn't run in the test suite and think you can fix it, create an issue and once you have the go ahead, go for it!

### Test `.mod` File

### Integration tests

It's useful to contribute `.mod` files that test some aspect of Dynare that is not currently tested. A `.mod` file that runs into a bug is perfect. As the test suite currently takes several hours to run, we prefer you modify a current test to also create the bug you've found. If you can't do that, please add a new test that runs as quickly as possible. It will contain only those commands necessary to create the bug, nothing more. To contribute a test, after having made an issue and cloned and forked the repository as described above, do the following:

1. Add and commit your test file and `tests/Makefile.am` as described above

1. Push and create a pull request as described above

### Unitary Tests

### Unit tests

So-called unit tests allow the test suite to check the correct functioning of the MATLAB/Octave functions contained in Dynare. To add a unit test you need to 

1. add the keyword ` % --*-- Unitary tests --*--` at the end of the `function` header to tell the testsuite that the file contains unit tests. 

1. Add the particular tests at the end of the file after a `return` by

   1. Starting a test with `%@test:INTEGER` 

   2. Adding a MATLAB/Octave test code that provides a pass/fail indicator `T` that takes on `true` if the test passed.

   3. Closing the test with `%@eof:INTEGER`

   where `INTEGER` denotes the number of the test.

An example testing the correct functionality of mode-computations for a normal distribution is

```

function m = compute_prior_mode(hyperparameters,shape) % --*-- Unitary tests --*--

return

%@test:1

% Normal density

try

    m1 = compute_prior_mode([1 1],3);

    t(1) = true;

catch

    t(1) = false;

end

%$

if t(1)

    t(2) = dassert(m1,1,1e-6);

end

T = all(t);

%@eof:1

```

You can also put a unit test after the closing `end`, but in this case you will need to preface each line with `%$`. See e.g.  https://git.dynare.org/Dynare/dseries/-/commit/be4a4d39c125b92ee84ef876d86e6ec947c522b8

	$(LN_S) -f $(bindir)/dynare-preprocessor$(EXEEXT) $(DESTDIR)$(pkglibdir)/matlab/preprocessor64/dynare_m$(EXEEXT)

# We don’t fail over doc install rules, since the user may deliberately not have compiled them

# (e.g. with the “nodoc” option under Debian)

	$(MKDIR_P) $(docdir)

	-cp doc/*.pdf doc/gsa/gsa.pdf doc/parallel/parallel.pdf doc/dseries-and-reporting/dseriesReporting.pdf preprocessor/doc/preprocessor/preprocessor.pdf preprocessor/doc/macroprocessor/macroprocessor.pdf doc/manual/build/latex/dynare-manual.pdf $(docdir)

	-cp -r doc/manual/build/html $(docdir)/dynare-manual.html

	$(MKDIR_P) $(docdir)/dynare++

	-cp dynare++/doc/*.pdf $(docdir)/dynare++

	$(MKDIR_P) $(DESTDIR)$(docdir)

	-cp doc/*.pdf doc/gsa/gsa.pdf doc/parallel/parallel.pdf doc/dseries-and-reporting/dseriesReporting.pdf preprocessor/doc/preprocessor/preprocessor.pdf preprocessor/doc/macroprocessor/macroprocessor.pdf doc/manual/build/latex/dynare-manual.pdf $(DESTDIR)$(docdir)

	-cp -r doc/manual/build/html $(DESTDIR)$(docdir)/dynare-manual.html

	$(MKDIR_P) $(DESTDIR)$(docdir)/dynare++

	-cp dynare++/doc/*.pdf $(DESTDIR)$(docdir)/dynare++

uninstall-local:

	rm -rf $(DESTDIR)$(pkglibdir)

A number of tools and libraries are needed in order to recompile everything. You don't necessarily need to install everything, depending on what you want to compile.

- A POSIX compliant shell and an implementation of Make (mandatory)

- The [GNU Compiler Collection](http://gcc.gnu.org/), version 8 or later, with

- The [GNU Compiler Collection](https://gcc.gnu.org/), version 8 or later, with

  gcc, g++ and gfortran (mandatory)

- [MATLAB](https://mathworks.com) (if you want to compile the MEX for MATLAB)

- [GNU Octave](http://www.octave.org) with

- [GNU Octave](https://www.octave.org) with

  - the development headers (if you want to compile the MEX for Octave)

  - the development libraries corresponding to the [UMFPACK](https://people.engr.tamu.edu/davis/suitesparse.html) packaged with Octave

  - Optionally, the [Control](https://wiki.octave.org/Control_package), [IO](https://wiki.octave.org/IO_package), [Optimization](https://wiki.octave.org/Optimization_package) and [Statistics](https://wiki.octave.org/Statistics_package) package either installed via your package manager or through [Octave Forge](https://wiki.octave.org/Category:Octave_Forge).

- [Boost libraries](http://www.boost.org), version 1.36 or later

- [Bison](http://www.gnu.org/software/bison/), version 3.2 or later (only if you get the source through Git)

- [Flex](http://flex.sourceforge.net/), version 2.5.4 or later (only if you get the source through Git)

- [Autoconf](http://www.gnu.org/software/autoconf/), version 2.62 or later (only if you get the source through Git)

- [Automake](http://www.gnu.org/software/automake/), version 1.11.2 or later (only if you get the source through Git)

- An implementation of BLAS and LAPACK: either [ATLAS](http://math-atlas.sourceforge.net/), [OpenBLAS](http://xianyi.github.com/OpenBLAS/), Netlib ([BLAS](http://www.netlib.org/blas/), [LAPACK](http://www.netlib.org/lapack/)) or [MKL](http://software.intel.com/en-us/intel-mkl/) (only if you want to build Dynare++)

- [MAT File I/O library](http://sourceforge.net/projects/matio/), version 1.5 or later (if you want to compile Markov-Switching code, the estimation DLL, k-order DLL and Dynare++)

  - Optionally, the [Control](https://octave.sourceforge.io/control/), [IO](https://octave.sourceforge.io/io/), [Optimization](https://octave.sourceforge.io/optim/) and [Statistics](https://octave.sourceforge.io/statistics/) package either installed via your package manager or through [Octave Forge](https://octave.sourceforge.io/).

- [Boost libraries](https://www.boost.org), version 1.36 or later

- [Bison](https://www.gnu.org/software/bison/), version 3.2 or later (only if you get the source through Git)

- [Flex](https://github.com/westes/flex), version 2.5.4 or later (only if you get the source through Git)

- [Autoconf](https://www.gnu.org/software/autoconf/), version 2.62 or later (only if you get the source through Git)

- [Automake](https://www.gnu.org/software/automake/), version 1.11.2 or later (only if you get the source through Git)

- An implementation of BLAS and LAPACK: either [ATLAS](http://math-atlas.sourceforge.net/), [OpenBLAS](https://www.openblas.net/), Netlib ([BLAS](https://www.netlib.org/blas/), [LAPACK](https://www.netlib.org/lapack/)) or [MKL](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html) (only if you want to build Dynare++)

- [MAT File I/O library](https://sourceforge.net/projects/matio/), version 1.5 or later (if you want to compile Markov-Switching code, the estimation DLL, k-order DLL and Dynare++)

- [SLICOT](http://www.slicot.org) (if you want to compile the Kalman steady state DLL)

- [GSL library](http://www.gnu.org/software/gsl/) (if you want to compile Markov-Switching code)

- [GSL library](https://www.gnu.org/software/gsl/) (if you want to compile Markov-Switching code)

- A decent LaTeX distribution (if you want to compile PDF documentation),

  ideally with Beamer

- For building the reference manual:

  - [Sphinx](http://www.sphinx-doc.org/)

  - [Sphinx](https://www.sphinx-doc.org/)

  - [MathJax](https://www.mathjax.org/)

- [Doxygen](http://www.stack.nl/%7Edimitri/doxygen/) (if you want to build Dynare preprocessor source documentation)

- [X-13ARIMA-SEATS Seasonal Adjustment Program](https://www.census.gov/srd/www/x13as/)

- [Doxygen](https://www.doxygen.nl) (if you want to build Dynare preprocessor source documentation)

- [X-13ARIMA-SEATS Seasonal Adjustment Program](https://www.census.gov/data/software/x13as.html)

### Preparing the sources

If you have downloaded the sources from an official source archive or the source snapshot, just unpack it.

If you want to use Git, do the following from a terminal:

If you want to use Git, do the following from a terminal (note that you must

have the [Git LFS](https://git-lfs.github.com/) extension installed):

```sh

git clone --recurse-submodules https://git.dynare.org/Dynare/dynare.git

cd dynare

autoreconf -si

```

The last line runs Autoconf and Automake in order to prepare the build environment (this is not necessary if you got the sources from an official source archive or the source snapshot). If you want a certain version (e.g. 4.6) , then add `--single-branch --branch 4.6` to the git clone command.

The last line runs Autoconf and Automake in order to prepare the build environment (this is not necessary if you got the sources from an official source archive or the source snapshot). If you want a certain version (e.g. 5.x) , then add `--single-branch --branch 5.x` to the git clone command.

### Configuring the build tree

- `libmatio-dev`

- `libslicot-dev` and `libslicot-pic`

- `libsuitesparse-dev`

- `flex`

- `flex` and `libfl-dev`

- `bison`

- `autoconf`

- `automake`

- `texlive-plain-generic`

- `lmodern` (for macroprocessor PDF)

- `python3-sphinx`

- `tex-gyre`

- `latexmk`

- `libjs-mathjax`

- `doxygen`

You can install them all at once with:

```sh

apt install build-essential gfortran liboctave-dev libboost-graph-dev libgsl-dev libmatio-dev libslicot-dev libslicot-pic libsuitesparse-dev flex bison autoconf automake texlive texlive-publishers texlive-latex-extra texlive-fonts-extra texlive-latex-recommended texlive-science texlive-plain-generic lmodern python3-sphinx latexmk libjs-mathjax doxygen x13as

apt install build-essential gfortran liboctave-dev libboost-graph-dev libgsl-dev libmatio-dev libslicot-dev libslicot-pic libsuitesparse-dev flex libfl-dev bison autoconf automake texlive texlive-publishers texlive-latex-extra texlive-fonts-extra texlive-latex-recommended texlive-science texlive-plain-generic lmodern python3-sphinx tex-gyre latexmk libjs-mathjax doxygen x13as

```

If you use MATLAB, we strongly advise to also `apt install matlab-support` and confirm to rename the GCC libraries shipped with MATLAB to avoid possible conflicts with GCC libraries shipped by your distribution.

Tested on

- Debian 10

- Debian “Buster” 10

- Debian “Bullseye” 11

- Ubuntu 20.04

- Ubuntu 20.10

# compile x13as from source and put it into /usr/bin/

mkdir -p /home/$USER/dynare/x13as

cd /home/$USER/dynare/x13as

wget https://www.census.gov/ts/x13as/unix/x13assrc_V1.1_B39.tar.gz

tar xf x13assrc_V1.1_B39.tar.gz

wget https://www2.census.gov/software/x-13arima-seats/x13as/unix-linux/program-archives/x13as_asciisrc-v1-1-b60.tar.gz

tar xf x13as_asciisrc-v1-1-b60.tar.gz

sed -i "s|-static| |" makefile.gf # this removes '-static' in the makefile.gf

make -f makefile.gf FFLAGS="-O2 -std=legacy" PROGRAM=x13as

sudo cp x13as /usr/bin/

## Windows

- Install [MSYS2](http://www.msys2.org) (pick the 64-bit version, unless you