Naming convention used for ParaMonte library builds

Across all supported Operating Systems (OS) and platforms / architectures, a universal naming convention is currently used to build the ParaMonte kernel libraries,

libparamonte_<interface language: c/cpp/fortran/matlab/python/...>_<OS: windows/linux/darwin/...>_<architecture: x64/x86/...>_<compiler suite: intel/gnu/...>_<build type: release/testing/debug>_<library type: dynamic/static>_<memory allocation type: stack/heap>_<parallelism type: (none)/mpi/cafsingle/cafshared/cafdistributed/...>.<library file extension: dll/lib/so/a/dylib>  

where,

  • interface language can be either:
    • c: indicating a library build that is meant to be called and used from C or C-complaint main applications.
    • cpp: indicating a library build that is meant to be called and used from C++ main applications.
    • fortran: indicating a library build that is meant to be called and used from Fortran main applications.
    • matlab: indicating a library build that is meant to be called and used from MATLAB main applications.
    • python: indicating a library build that is meant to be called and used from Python main applications.
  • operating system type can be either:
    • windows: indicating a library that can only be used on Windows OS, or,
    • darwin: indicating a library that can only be used on macOS, or,
    • linux: indicating a library that can only be used on Linux OS, or,
    • some other name (or unknown if it cannot be identified), indicating a library build that is meant to be used on the specific OS for which the library has been built.
  • architecture type can be either:
    • x64: indicating a library that is built usage on amd64 64-bit architectures (also known as x86_64), or,
    • some other architecture (or unknown if it cannot be identified), indicating a library build that is meant to be used on the specific architecture for which the library has been built.
  • compiler suite can be any ParaMonte-compatible compiler vendor name that you are using to build the ParaMonte library. Currently, the ParaMonte build-scripts support only:
    • intel: on Windows and Linux OS for both serial and parallel ParaMonte library builds, as well as on Darwin (macOS), but only for serial ParaMonte library builds,
    • gnu: on Linux and Darwin OS for both serial and parallel ParaMonte library builds.
  • build type can be either:
    • release: indicating a build with compiler flags that ensure the fastest possible simulations at runtime, or,
    • testing: indicating a build with compiler default optimization flags used only for testing purposes, or,
    • debug: indicating a build with compiler flags that enable tracing of any compile-time or run-time errors.
  • library type can be either:
    • dynamic: indicating a dynamically-linked ParaMonte library build, or,
    • static: indicating a statically-linked (archive) ParaMonte library build.
  • memory allocation type can be either:
    • stack: indicating static allocation of all automatic arrays and arrays created for temporary computations on the stack, or,
    • heap: indicating heap allocation of all automatic arrays and arrays created for temporary computations on the heap).
  • parallelism type can be either:
    • NULL: indicating no parallelism, that is, a library built for serial simulations, or,
    • mpi: indicating a library built via Message Passing Interface (MPI) that is meant to be linked against parallel main applications for parallel simulations via MPI, or,
    • cafsingle: indicating a library built via Coarray Fortran parallelism paradigm that is meant to be linked against Coarray parallel main applications optimized and usable for serial simulations only (i.e., no parallelization), or,
    • cafshared: indicating a library built via Coarray Fortran parallelism paradigm that is meant to be linked against Coarray parallel main applications for coarray-enabled parallel simulations on shared-memory architecture, or,
    • cafdistributed: indicating a library built via Coarray Fortran parallelism paradigm that is meant to be used for coarray-enabled parallel simulations on distributed-memory architecture, or,
    • nothing, indicating a library build that is to be linked against serial main applications,

Supported platform and architecture

The ParaMonte library is currently developed with the presumption that it will be used on Windows/Linux/macOS operating systems (OS) built on an amd64 architecture system (also known as x64 on Windows, and x86_64 on Linux and macOS). There is, however, no technical or programming barrier to building ParaMonte for other architectures, as long as a compatible MPI and Fortran/C compilers are available on the specific platform and architecture of interest.

Why are the prebuilt ParaMonte libraries available only for the x64 architecture?

As of 2020, the amd64 processor architecture takes the lion share of the market demand (illustrated in the figure below). It would be very costly for the ParaMonte developers (in terms of energy, money, and time) to build and release the library for all available architectures in the market. Note, however, that the library can be built for usage on any architecture as long as a ParaMonte-compatible C/Fortran compiler can be installed on the system.

An illustration of the dynamics of the market share for different families of microprocessors in the TOP500 supercomputer ranking list, from 1992 to 2019.

How can I find out the platform and architecture of my system?

  • On Windows OS, open a Windows command-line interface (cmd.exe).
    • To find out your system’s OS, type,
      echo %OS%
      

      which should result in an answer like the following,

      Windows_NT
      
    • To check your system’s platform/architecture, type,
      echo %PLATFORM%
      

      which should result in an answer like the following,

      x64
      

      or,

      echo %PROCESSOR_ARCHITECTURE%
      

      which should result in an answer like the following,

      AMD64
      

      if your system’s architecture is amd64.


  • On Unix-like OS (Linux/macOS), open a Bash shell.
    • To find out your system’s OS, type,
      uname -s
      

      which should result in an answer like the following,

      Linux
      

      or,

      Darwin
      

      depending on the type of your OS.

    • To check your system’s platform/architecture, type,
      uname -m
      

      which should result in an answer like the following,

      x86_64
      

      if your system’s architecture is amd64.


If you have any questions about the topics discussed on this page, feel free to ask in the comment section below or reach out to the ParaMonte library authors.