Skip to content
Snippets Groups Projects

Changes

Page history
  • New page
  • Templates
    • Update Installation authored by Dario Barghini's avatar Dario Barghini
    Show whitespace changes
    Inline Side-by-side
    Showing
    with 9 additions and 6 deletions
    Installation.md
    View page @ 88640b02
    ...@@ -33,24 +33,27 @@ The folder structure needed for the execution of the PRISMA pipeline and detaile ...@@ -33,24 +33,27 @@ The folder structure needed for the execution of the PRISMA pipeline and detaile
    The complete workspace for the PRISMA pipeline is hosted in a separate repository named [PRISMA-workspace](https://www.ict.inaf.it/gitlab/dario.barghini/prisma-workspace), which is freely available to PRISMA collaborators only, since it hosts detailed information about the PRISMA stations, their location and configuration. The complete workspace for the PRISMA pipeline is hosted in a separate repository named [PRISMA-workspace](https://www.ict.inaf.it/gitlab/dario.barghini/prisma-workspace), which is freely available to PRISMA collaborators only, since it hosts detailed information about the PRISMA stations, their location and configuration.
    If you do not have access to it, the workspace is easily reproducible following the guidelines detailed in the [Workspace](Workspace) page. If you do not have access to it, the workspace is easily reproducible following the guidelines detailed in the [Workspace](Workspace) page.
    If you have access to it, the PRISMA-workspace repository is linked to the pipeline via a git submodule in the workspace folder. If you have access to it, the PRISMA-workspace repository is linked to the pipeline via a git submodule in the `workspace` folder.
    When cloning directly from this repository, remember to include the `--recurse-submodules` option to automatically pull its content from the submodule. When cloning directly from this repository, remember to include the `--recurse-submodules` option to automatically pull its content from the submodule.
    Most of the directories contained in the workspace will be empty at the beginning since they will contain data (input) and results (output) of the pipeline itself. Most of the directories contained in the workspace will be empty at the beginning since they will contain data (input) and results (output) of the pipeline itself.
    # Settings # Settings
    Some machine-dependent modifications are needed for the PRISMA pipeline to be fully operative on your computer. After recreating the workspace, some machine-dependent modifications are needed for the PRISMA pipeline to be fully operative on your computer.
    They are all enclosed in the `configuration.ini` file inside the settings directory of the workspace: `/your_path_to_the/workspace/settings/configuration.ini`. They are all enclosed in the [`configuration.ini`](https://www.ict.inaf.it/gitlab/dario.barghini/prisma-workspace/-/blob/main/settings/configuration.ini) file inside the settings directory of the workspace: `/your_path_to_the/workspace/settings/configuration.ini`.
    More details about this file are given in the [Settings](Settings) page. More details about this file are given in the [Settings](Settings) page.
    The configuration file in the workspace is designed for execution on the PRISMA servers.
    If you do not have access to the workspace, you can find a template [here](uploads/configuration_template.ini)
    To make the pipeline working, you have to adjust a few fields in the configuration file.
    To do so, open [`configuration.ini`] with a text editor and modify the following:
    To do so, open the configuration file with a text editor.
    You should modify the following:
    ### Path ### Path
    This section contains the different paths to workspace folders and to specific files needed for the pipeline. This section contains the different paths to workspace folders and to specific files needed for the pipeline.
    Each entry must have the absolute path to its target on your machine; names and descriptions of entries should be self-explanatory. Each entry must have the absolute path to its target on your machine; names and descriptions of entries should be self-explanatory and are however detailed in the [Workspace](Workspace) page.
    A simple find/replace should get the job done. A simple find/replace should get the job done.
    In practice, you are not forced to put all directories of the workspace “physically” in the same directory, since the path section specifies the absolute path to each one of these. In practice, you are not forced to put all directories of the workspace “physically” in the same directory, since the path section specifies the absolute path to each one of these.
    ......