###########################################################################################
INSTALLING AMD ZEN SOFTWARE STUDIO (ZSS) SUITE
###########################################################################################

Packages:
---------
    This suite contains 
       1. "AMD Optimizing C/C++ and Fortran Compilers" - abbreviated as AOCC
       2. "AMD Optimizing CPU Libraries" - abbreviated as AOCL
       3. "AMD MICRO Profiler" - abbreviated as uProf
       4. AMD Pre-Built HPC Benchmarks
       5. AMD Python Libraries with AOCL

Installation steps:
-------------------
       1. Use the command tar -xvf zen-software-studio-<version>.tar to untar the ZSS suite.

       2. The installer file install.sh is available in extracted directory zen-software-studio-<version>.

       3. Run ./install.sh to install all the packages (AOCC, AOCL, uProf, hpc_benchmarks and pylibs) to default 
          location: /opt/zss/<version>.
              - Installation at default location requires root or sudo privileges.

       4. To install the ZSS packages in a custom location, use the installer with the 
          option: -t <CUSTOM_PATH>.

          For example, ./install.sh -t /home/<username>.

       5. This installer file install.sh can also be used to install individual component(s).
              - The component can be one or more of the below packages, separated by a space    
                                          aocc            Install AOCC package                                      
                                          aocl            Install AOCL package                                      
                                          uprof           Install uProf package                                     
                                          hpc_benchmarks  Copy pre-built HPC benchmarks                    
                                          pylibs          Copy Python libraries with AOCL                           
                                          all             Install all the above packages (default)
                For example, ./install.sh -i aocc aocl

              - To install all components (aocc, aocl, uprof, hpc_benchmarks and pylibs), use the option -i followed 
                by the component name as all.
                For example, sudo ./install.sh -i all

              - You can also install the individual component in a path of your choice.
                For example, sudo ./install.sh -i aocl -t /opt

        6. You can set LP64 or ILP64 libraries as default for aocl with the option:
           -l <libraries>. Where libraries can be LP64 or ILP64. Default is set to LP64.

           For example, sudo ./install -i all -t /opt -l ILP64 

        7. To view the "USAGE" information along with all supported options, use the -h or --help option.

        8. Use the -v option to enable verbose mode.

        9. source <CUSTOM_PATH>/zss/<version>/setenv_ZSS.sh
              - Executing the command above will set up a shell environment for utilizing AOCC, AOCL, and uProf, 
                provided they were chosen during installation.

Note:
-----
        1. The following pre-built components are copied to <CUSTOM_PATH> and do not require installation:
              -    AMD Pre-Built HPC Benchmarks
              -    AMD Python Libraries with AOCL

        2.  By sourcing setenv_ZSS.sh, paths for the installed components will get precedence over user environment.

References:
-----------
        1. AOCC: https://www.amd.com/en/developer/aocc.html
        2. AOCL: https://www.amd.com/en/developer/aocl.html
        3. uProf: https://www.amd.com/en/developer/uprof.html
        4. Pre-Built HPC Benchmarks: https://www.amd.com/en/developer/zen-software-studio/applications/pre-built-applications.html
        5. Python Libraries with AOCL: https://www.amd.com/en/developer/zen-software-studio/applications/python-libraries-with-aocl.html