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 15 additions and 6 deletions
    Installation.md
    View page @ ddbe7268
    ......@@ -4,25 +4,34 @@ The code should be compatible with IDL v7 onwards.
    IDL is a proprietary language and you need an IDL license to execute the pipeline.
    An open-source IDL compiler is available ([GDL - GNU Data Language](https://gnudatalanguage.github.io/)) but its full compatibility with the PRISMA pipeline is not granted.
    The pipeline was developed on a Microsoft Windows 10/11 platform and is fully functional on Linux (tested on Ubuntu 18 server). To execute it on MacOS, some modifications may be needed (mostly for the graphical part).
    The pipeline was developed on a Microsoft Windows 10/11 platform and is fully functional on Linux (tested on Ubuntu 18 server).
    To execute it on MacOS, some modifications may be needed (mostly for the graphical part).
    This repository is made of two main parts: the code of the pipeline itself and the workspace for its execution.
    ### Code
    This folder contains the PRISMA pipeline code and third-part libraries.
    This folder contains the PRISMA pipeline code, i.e., its main procedures ([`calibration.pro`](https://www.ict.inaf.it/gitlab/dario.barghini/prisma-pipeline/-/blob/main/code/calibration/calibration.pro) and [`event.pro`](https://www.ict.inaf.it/gitlab/dario.barghini/prisma-pipeline/-/blob/main/code/event/event.pro)) and functions.
    It must be placed in a dedicated path from which IDL will autocompile procedures or functions when called the first time in an IDL session.
    This can be either:
    - the **standard IDL path**, where all IDL native libraries are found. On a Windows machine, this is usually: `C:\Program Files\Harris\IDL88\lib`. You will need administrator privilege to copy-paste in this directory. Be very careful when you are operating in this directory, since any modifications/deletion of native code may corrupt IDL and you will need to perform a new clean installation to solve the issue.
    - the **standard IDL path**, where all IDL native libraries are found.
    On a Windows machine, this is usually: `C:\Program Files\Harris\IDL88\lib`.
    You will need administrator privilege to copy-paste in this directory.
    Be very careful when you are operating in this directory, since any modifications/deletion of native code may corrupt IDL and you will need to perform a new clean installation to solve the issue.
    - an **user-defined IDL path**. This is the recommended option. To do so, you have to add a new folder to the IDL path. Start an IDLde (Development Environment) session, then go to `Window->Preferences->IDL->Paths`. Click `Add` and browse for your directory. You now have to tick the new directory in the embedded list and click `Apply`. For the modification to be effective, close and restart the IDL session. This directory should contain only IDL code, and nothing else.
    - an **user-defined IDL path**. This is the recommended option.
    To do so, you have to add a new folder to the IDL path. Start an IDLde (Development Environment) session, then go to `Window->Preferences->IDL->Paths`.
    Click `Add` and browse for your directory. You now have to tick the new directory in the embedded list and click `Apply`.
    For the modification to be effective, close and restart the IDL session.
    This directory should contain only IDL code, and nothing else.
    ### Workspace
    The folder structure needed for the execution of the PRISMA pipeline and detailed in the [Workspace](Workspace) page.
    Most of these directories will be empty at the beginning since they will contain data (input) and results (output) of the pipeline itself.
    In the workspace uploaded in this repository, a few examples of calibration and event data and results are given as a reference.
    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.
    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
    ......