1. Installation

Was tested only on Linux or MacOs systems.

1.1. User installation (without git)

If you do not need to get last update (ie if you have no interaction with developer(s)), this should be your installation of choice. Requires conda.

  1. Create a conda environment (here the environment is named astec-test)

    conda create -n astec-test -c morpheme -c conda-forge astec

  2. Activate the built conda environment

    conda activate astec-test

    Update of packages can be done with

    conda update -n astec-test -c morpheme -c conda-forge astec

1.2. User installation (with git)

Requires conda and git.

  1. Astec code can be found at gitlab.inria.fr/astec/astec. It can be downloaded with

    git clone https://gitlab.inria.fr/astec/astec.git

    It creates an astec directory.

  2. Create a conda environment named astec

    cd astec
conda env create -f pkg/env/astec.yaml

  3. Activate the built conda environment

    conda activate astec

1.3. Developer installation (with git)

Requires conda and git.

  1. Astec code can be found at gitlab.inria.fr/astec/astec. It can be downloaded with

    git clone https://gitlab.inria.fr/astec/astec.git

    It creates an astec directory.

  2. Create a conda environment named astec-dev

    cd astec
conda env create -f pkg/env/astec-dev.yaml

  3. Activate the built conda environment

    conda activate astec-dev

  4. Install astec package for use

    python -m pip install -e .

    The -e option install the package in “editable” mode, this is want you want if you aim at contributing to the astec project. This last command has to be repeated (within the conda environment every time the astec code has been modified).

1.4. Documentation update (with git)

This environment only allows to update the documentation, not to test code changes (use astec-dev then). Requires conda and git.

  1. Astec code can be found at gitlab.inria.fr/astec/astec. It can be downloaded with

    git clone https://gitlab.inria.fr/astec/astec.git

    It creates an astec directory.

  2. Create a conda environment named astec-doc

    cd astec
conda env create -f pkg/env/astec-doc.yaml

  3. Activate the built conda environment

    conda activate astec-doc

  4. Build documentation

    Assume you are in the astec directory created at step 1:

    cd doc
make html

    The documentation will be built into the astec/doc/build/ directory, and can be accessed through astec/doc/build/html/index.html with your favorite browser. Documentation can also be built within the astec-dev conda environment.