This module contains procedures and data that provide general information about the ParaMonte library, its interfaces, and its build. More...

Data Types
type	envis_type
	This is the derived type for generating objects containing scalar components of type `logical` named after different programming language environments that are currently or will be supported for access to the ParaMonte library. More...

type	paramonte_type
	This a derived type devoid of any components or methods whose instantiated objects are used within the ParaMonte library to signify the use of the ParaMonte style (vs. alternative approaches) in performing various actions within the library. More...

Functions/Subroutines
PURE character(:, SK) function, allocatable	getParaMonteSplash (width, lwsize, twsize, rwsize, bwsize, fill, lwfill, twfill, rwfill, bwfill)
	Generate and return an `allocatable` scalar `character` of default kind SK containing the ParaMonte library splash information centered with the requested line width, margins, and fillings. More...

Variables
character(*, SK), parameter	PARAMONTE_WEB_REPOSITORY = SK_"https://github.com/cdslaborg/paramonte"
	The scalar constant of type `character` of default kind SK, containing the web portal address for the ParaMonte library repository. More...

character(*, SK), parameter	PARAMONTE_WEB_ISSUES = SK_"https://github.com/cdslaborg/paramonte/issues"
	The scalar constant of type `character` of default kind SK, containing the web portal address for reporting the ParaMonte library issues. More...

character(*, SK), parameter	PARAMONTE_WEB_DOC = SK_"https://www.cdslab.org/paramonte/"
	The scalar constant of type `character` of default kind SK, containing the web portal address for reporting the ParaMonte library issues. More...

character(*, SK), parameter	PARAMONTE_COMPILER_VERSION = compiler_version()
	The scalar constant of type `character` of default kind SK, containing the version of the compiler with which the ParaMonte library has been built. More...

character(*, SK), parameter	PARAMONTE_COMPILER_OPTIONS = compiler_options()
	The scalar constant of type `character` of default kind SK, containing the compiler options used to build the ParaMonte library. More...

type(paramonte_type), parameter	paramonte = paramonte_type()
	The scalar module constant of type paramonte_type that can be used within the ParaMonte library to signify the use of the ParaMonte style (vs. alternative approaches) in performing various actions within the library. More...

character(*, SK), parameter	envname = PROGNAME//" programming language"
	The scalar constant of type `character` of default kind SK containing the full generic name of the programming language environment for which the ParaMonte library has been configured. More...

type(envis_type), parameter	envis = envis_type(PROGLANG = .true._LK)
	The scalar constant object of type envis_type whose components are all `.false.` except the environment for which the ParaMonte library is currently configured. More...

character(*, SK), parameter	PARAMONTE_BUILD_DATE = __TIMESTAMP__
	The `public` scalar `character` constant of default kind SK containing the ParaMonte library build date. More...

character(*, SK), parameter	PARAMONTE_VERSION = __PARAMONTE_VERSION__
	The `public` scalar `character` constant of default kind SK containing the ParaMonte library version. More...

character(*, SK), parameter	PARAMONTE_SPLASH = NLC//NLC// SK_"ParaMonte"//NLC// SK_"Parallel Monte Carlo and"//NLC// SK_"Machine Learning Library"//NLC// NLC// SK_"Version "//PARAMONTE_VERSION//NLC// NLC// SK_"Build: "//PARAMONTE_BUILD_DATE//NLC// NLC// SK_"Developed by"//NLC// NLC// SK_"The computational Data Science Lab"//NLC// NLC// SK_"at"//NLC// NLC// SK_"Division of Data Science"//NLC// SK_"Department of Physics & Astronomy"//NLC// SK_"The University of Texas at Arlington"//NLC// NLC// SK_"Multiscale Modeling Group"//NLC// SK_"Center for Computational Oncology"//NLC// SK_"Oden Institute for Computational Engineering and Sciences"//NLC// SK_"Department of Aerospace Engineering and Engineering Mechanics"//NLC// SK_"Department of Neurology, Dell-Seton Medical School"//NLC// SK_"Department of Biomedical Engineering"//NLC// SK_"The University of Texas at Austin"//NLC// NLC// SK_"For questions and further information, please contact the PI:"//NLC// NLC// SK_"Amir Shahmoradi"//NLC// SK_"shahmoradi@utexas.edu"//NLC// SK_"cdslab.org/pm"//NLC// NLC//NLC
	The `public` scalar `character` constant of default kind SK containing the ParaMonte splash information. More...

Detailed Description

This module contains procedures and data that provide general information about the ParaMonte library, its interfaces, and its build.

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, Monday 00:01 AM, January 1, 2018, Institute for Computational Engineering and Sciences, University of Texas Austin

Function/Subroutine Documentation

◆ getParaMonteSplash()

PURE character(:, SK) function, allocatable pm_paramonte::getParaMonteSplash	(	integer(IK), intent(in), optional	width,
		integer(IK), intent(in), optional	lwsize,
		integer(IK), intent(in), optional	twsize,
		integer(IK), intent(in), optional	rwsize,
		integer(IK), intent(in), optional	bwsize,
		character(1, SK), intent(in), optional	fill,
		character(1, SK), intent(in), optional	lwfill,
		character(1, SK), intent(in), optional	twfill,
		character(1, SK), intent(in), optional	rwfill,
		character(1, SK), intent(in), optional	bwfill
	)

Generate and return an allocatable scalar character of default kind SK containing the ParaMonte library splash information centered with the requested line width, margins, and fillings.

See the documentation of PARAMONTE_SPLASH for further splash information details.
The output splash begins and ends with a newline character returned by the intrinsic new_line("a") for the requested character kind.

Parameters

[in]	width	: The input scalar `integer` of default kind IK, containing the width of the splash including the lengths of the left and right margins. (optional, default = `132`.)
[in]	lwsize	: The input scalar `integer` of default kind IK representing the width of the left wrapper margin of each line of the output `splash`. (optional, default = `4`.)
[in]	twsize	: The input scalar `integer` of default kind IK representing the width of the top wrapper margin of the output `splash`. (optional, default = `2`.)
[in]	rwsize	: The input scalar `integer` of default kind IK representing the width of the right wrapper margin of each line of the output `splash`. (optional, default = `4`.)
[in]	bwsize	: The input scalar `integer` of default kind IK representing the width of the bottom wrapper margin of the output `splash`. (optional, default = `2`.)
[in]	fill	: The input scalar of the same type and kind as the output `slpash`, of length type parameter `1`, containing the value to fill the new elements (if any, excluding the margins) surrounding the splash text in each line of the output splash. (optional, default = `" "`, the whitespace character.)
[in]	lwfill	: The input scalar of the same type and kind as the output `slpash`, of length type parameter `1`, containing the value to fill the left wrapper margin (if any) of each line of the output `splash`. (optional, default = `"%"`.)
[in]	twfill	: The input scalar of the same type and kind as the output `slpash`, of length type parameter `1`, containing the value to fill the top wrapper margin (if any) of the output `splash`. (optional, default = `"%"`.)
[in]	rwfill	: The input scalar of the same type and kind as the output `slpash`, of length type parameter `1`, containing the value to fill the right wrapper margin (if any) of each line of the output `splash`. (optional, default = `"%"`.)
[in]	bwfill	: The input scalar of the same type and kind as the output `slpash`, of length type parameter `1`, containing the value to fill the bottom wrapper margin (if any) of the output `splash`. (optional, default = `"%"`.)

Returns: splash : The output allocatable scalar of type character of default kind SK, containing the ParaMonte splash.
Lines within the splash are separated via the newline character returned by the intrinsic new_line(SK_"a").

Possible calling interfaces ⛓

: use pm_paramonte, only: getParaMonteSplash

character(:, SK), allocatable :: splash

splash = getParaMonteSplash(width = width, lwsize = lwsize, twsize = twsize, rwsize = rwsize, bwsize = bwsize, fill = fill, lwfill = lwfill, twfill = twfill, rwfill = rwfill, bwfill = bwfill)

pm_paramonte
This module contains procedures and data that provide general information about the ParaMonte library...
Definition: pm_paramonte.F90:39

pm_paramonte::getParaMonteSplash
PURE character(:, SK) function, allocatable getParaMonteSplash(width, lwsize, twsize, rwsize, bwsize, fill, lwfill, twfill, rwfill, bwfill)
Generate and return an allocatable scalar character of default kind SK containing the ParaMonte libra...
Definition: pm_paramonte.F90:623

Warning: The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.

See also: PARAMONTE_SPLASH
PARAMONTE_VERSION
PARAMONTE_BUILD_DATE
getParaMonteSplash

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK

4 use pm_io, only: display_type

5 use pm_paramonte, only: getParaMonteSplash

6

7 implicit none

8

9 type(display_type) :: disp

10 disp = display_type(file = "main.out.F90")

11

12 call disp%skip()

13 call disp%show("getParaMonteSplash()")

14 call disp%show( getParaMonteSplash() , deliml = SK_"""" )

15 call disp%skip()

16

17 call disp%skip()

18 call disp%show("getParaMonteSplash(width = 90_IK, fill = SK_'.', lwfill = SK_'.', rwfill = SK_'.')")

19 call disp%show( getParaMonteSplash(width = 90_IK, fill = SK_'.', lwfill = SK_'.', rwfill = SK_'.') , deliml = SK_"""" )

20 call disp%skip()

21

22 call disp%skip()

23 call disp%show("getParaMonteSplash(width = 90_IK, fill = SK_'.', lwsize = 1_IK, twsize = 1_IK, rwsize = 2_IK, bwsize = 3_IK, lwfill = SK_':', twfill = SK_'-', rwfill = SK_'/', bwfill = SK_'%')")

24 call disp%show( getParaMonteSplash(width = 90_IK, fill = SK_'.', lwsize = 1_IK, twsize = 1_IK, rwsize = 2_IK, bwsize = 3_IK, lwfill = SK_':', twfill = SK_'-', rwfill = SK_'/', bwfill = SK_'%') , deliml = SK_"""" )

25 call disp%skip()

26

27 call disp%skip()

28 call disp%show("getParaMonteSplash(width = 30_IK)")

29 call disp%show( getParaMonteSplash(width = 30_IK) , deliml = SK_"""" )

30 call disp%skip()

31

32end program example

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::IK
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540

pm_kind::SK
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539

pm_io::display_type
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe

2set PATH=..\..\..\lib;%PATH%

3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe

4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example output ⛓
1

2getParaMonteSplash()

3"

4%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

5%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

6%%%% %%%%

7%%%% %%%%

8%%%% ParaMonte %%%%

9%%%% Parallel Monte Carlo and %%%%

10%%%% Machine Learning Library %%%%

11%%%% %%%%

12%%%% Version 2.0.0 %%%%

13%%%% %%%%

14%%%% Build: Thu Nov 7 13:37:00 2024 %%%%

15%%%% %%%%

16%%%% Developed by %%%%

17%%%% %%%%

18%%%% The computational Data Science Lab %%%%

19%%%% %%%%

20%%%% at %%%%

21%%%% %%%%

22%%%% Department of Physics %%%%

23%%%% Data Science Program, College of Science %%%%

24%%%% The University of Texas at Arlington %%%%

25%%%% %%%%

26%%%% Multiscale Modeling Group %%%%

27%%%% Center for Computational Oncology %%%%

28%%%% Oden Institute for Computational Engineering and Sciences %%%%

29%%%% Department of Aerospace Engineering and Engineering Mechanics %%%%

30%%%% Department of Neurology, Dell-Seton Medical School %%%%

31%%%% Department of Biomedical Engineering %%%%

32%%%% The University of Texas at Austin %%%%

33%%%% %%%%

34%%%% For questions and further information, please contact the PI: %%%%

35%%%% %%%%

36%%%% Amir Shahmoradi %%%%

37%%%% shahmoradi@utexas.edu %%%%

38%%%% cdslab.org/pm %%%%

39%%%% %%%%

40%%%% %%%%

41%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

42%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

43"

44

45

46getParaMonteSplash(width = 90_IK, fill = SK_'.', lwfill = SK_'.', rwfill = SK_'.')

47"

48%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

49%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

50..........................................................................................

51..........................................................................................

52........................................ParaMonte.........................................

53.................................Parallel Monte Carlo and.................................

54.................................Machine Learning Library.................................

55..........................................................................................

56......................................Version 2.0.0.......................................

57..........................................................................................

58.............................Build: Thu Nov 7 13:37:00 2024..............................

59..........................................................................................

60.......................................Developed by.......................................

61..........................................................................................

62............................The computational Data Science Lab............................

63..........................................................................................

64............................................at............................................

65..........................................................................................

66..................................Department of Physics...................................

67.........................Data Science Program, College of Science.........................

68...........................The University of Texas at Arlington...........................

69..........................................................................................

70................................Multiscale Modeling Group.................................

71............................Center for Computational Oncology.............................

72................Oden Institute for Computational Engineering and Sciences.................

73..............Department of Aerospace Engineering and Engineering Mechanics...............

74....................Department of Neurology, Dell-Seton Medical School....................

75...........................Department of Biomedical Engineering...........................

76............................The University of Texas at Austin.............................

77..........................................................................................

78..............For questions and further information, please contact the PI:...............

79..........................................................................................

80.....................................Amir Shahmoradi......................................

81..................................shahmoradi@utexas.edu...................................

82......................................cdslab.org/pm.......................................

83..........................................................................................

84..........................................................................................

85%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

86%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

87"

88

89

90getParaMonteSplash(width = 90_IK, fill = SK_'.', lwsize = 1_IK, twsize = 1_IK, rwsize = 2_IK, bwsize = 3_IK, lwfill = SK_':', twfill = SK_'-', rwfill = SK_'/', bwfill = SK_'%')

91"

92------------------------------------------------------------------------------------------

93:.......................................................................................//

94:.......................................................................................//

95:.......................................ParaMonte.......................................//

96:...............................Parallel Monte Carlo and................................//

97:...............................Machine Learning Library................................//

98:.......................................................................................//

99:.....................................Version 2.0.0.....................................//

100:.......................................................................................//

101:............................Build: Thu Nov 7 13:37:00 2024............................//

102:.......................................................................................//

103:.....................................Developed by......................................//

104:.......................................................................................//

105:..........................The computational Data Science Lab...........................//

106:.......................................................................................//

107:..........................................at...........................................//

108:.......................................................................................//

109:.................................Department of Physics.................................//

110:.......................Data Science Program, College of Science........................//

111:.........................The University of Texas at Arlington..........................//

112:.......................................................................................//

113:...............................Multiscale Modeling Group...............................//

114:...........................Center for Computational Oncology...........................//

115:...............Oden Institute for Computational Engineering and Sciences...............//

116:.............Department of Aerospace Engineering and Engineering Mechanics.............//

117:..................Department of Neurology, Dell-Seton Medical School...................//

118:.........................Department of Biomedical Engineering..........................//

119:...........................The University of Texas at Austin...........................//

120:.......................................................................................//

121:.............For questions and further information, please contact the PI:.............//

122:.......................................................................................//

123:....................................Amir Shahmoradi....................................//

124:.................................shahmoradi@utexas.edu.................................//

125:.....................................cdslab.org/pm.....................................//

126:.......................................................................................//

127:.......................................................................................//

128%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

129%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

130%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

131"

132

133

134getParaMonteSplash(width = 30_IK)

135"

136%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

137%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

138%%%% %%%%

139%%%% %%%%

140%%%% ParaMonte %%%%

141%%%% Parallel Monte Carlo and %%%%

142%%%% Machine Learning Library %%%%

143%%%% %%%%

144%%%% Version 2.0.0 %%%%

145%%%% %%%%

146%%%% Build: Thu Nov 7 13:37:00 2024 %%%%

147%%%% %%%%

148%%%% Developed by %%%%

149%%%% %%%%

150%%%% The computational Data Science Lab %%%%

151%%%% %%%%

152%%%% at %%%%

153%%%% %%%%

154%%%% Department of Physics %%%%

155%%%% Data Science Program, College of Science %%%%

156%%%% The University of Texas at Arlington %%%%

157%%%% %%%%

158%%%% Multiscale Modeling Group %%%%

159%%%% Center for Computational Oncology %%%%

160%%%%en Institute for Computational Engineering and Scienc%%%%

161%%%%rtment of Aerospace Engineering and Engineering Mecha%%%%

162%%%% Department of Neurology, Dell-Seton Medical School %%%%

163%%%% Department of Biomedical Engineering %%%%

164%%%% The University of Texas at Austin %%%%

165%%%% %%%%

166%%%%questions and further information, please contact the%%%%

167%%%% %%%%

168%%%% Amir Shahmoradi %%%%

169%%%% shahmoradi@utexas.edu %%%%

170%%%% cdslab.org/pm %%%%

171%%%% %%%%

172%%%% %%%%

173%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

174%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

175"

176

177

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas Austin

Definition at line 622 of file pm_paramonte.F90.

References PARAMONTE_SPLASH.

Variable Documentation

◆ envis

type(envis_type), parameter pm_paramonte::envis = envis_type(PROGLANG = .true._LK)

The scalar constant object of type envis_type whose components are all .false. except the environment for which the ParaMonte library is currently configured.

See also: envis
envis_type
envname

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 363 of file pm_paramonte.F90.

◆ envname

character(*, SK), parameter pm_paramonte::envname = PROGNAME//" programming language"

The scalar constant of type character of default kind SK containing the full generic name of the programming language environment for which the ParaMonte library has been configured.

See also: envis
envis_type
envname

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 312 of file pm_paramonte.F90.

◆ paramonte

type(paramonte_type), parameter pm_paramonte::paramonte = paramonte_type()

The scalar module constant of type paramonte_type that can be used within the ParaMonte library to signify the use of the ParaMonte style (vs. alternative approaches) in performing various actions within the library.

See also: paramonte
PARAMONTE_WEB_DOC
PARAMONTE_WEB_ISSUES
PARAMONTE_WEB_REPOSITORY
PARAMONTE_COMPILER_OPTIONS
PARAMONTE_COMPILER_VERSION
paramonte_type
getBaseName
getDirName

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 199 of file pm_paramonte.F90.

◆ PARAMONTE_BUILD_DATE

character(*, SK), parameter pm_paramonte::PARAMONTE_BUILD_DATE = __TIMESTAMP__

The public scalar character constant of default kind SK containing the ParaMonte library build date.

The generated date is,

the value of the predefined compiler preprocessor macro __TIMESTAMP__ if the compiler suite is Intel or GNU.
the value of CMake build generator TIMESTAMP with format "%a %b %d %H:%M:%S %Y" if the build is configured with CMake.

Possible calling interfaces ⛓

: use pm_paramonte, only: PARAMONTE_BUILD_DATE

print *, PARAMONTE_BUILD_DATE

pm_paramonte::PARAMONTE_BUILD_DATE
character(*, SK), parameter PARAMONTE_BUILD_DATE
The public scalar character constant of default kind SK containing the ParaMonte library build date.
Definition: pm_paramonte.F90:408

See also: PARAMONTE_SPLASH
PARAMONTE_VERSION
PARAMONTE_BUILD_DATE
getParaMonteSplash

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK

4 use pm_io, only: display_type

5 use pm_paramonte, only: PARAMONTE_BUILD_DATE

6

7 implicit none

8

9 type(display_type) :: disp

10 disp = display_type(file = "main.out.F90")

11

12 call disp%skip()

13 call disp%show("PARAMONTE_BUILD_DATE")

14 call disp%show( PARAMONTE_BUILD_DATE , deliml = SK_"""" )

15 call disp%skip()

16

17end program example

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe

2set PATH=..\..\..\lib;%PATH%

3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe

4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example output ⛓
1

2PARAMONTE_BUILD_DATE

3"Thu Nov 7 13:37:00 2024"

4

5

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas Austin

Definition at line 408 of file pm_paramonte.F90.

◆ PARAMONTE_COMPILER_OPTIONS

character(*, SK), parameter pm_paramonte::PARAMONTE_COMPILER_OPTIONS = compiler_options()

The scalar constant of type character of default kind SK, containing the compiler options used to build the ParaMonte library.

See also: paramonte
PARAMONTE_WEB_DOC
PARAMONTE_WEB_ISSUES
PARAMONTE_WEB_REPOSITORY
PARAMONTE_COMPILER_OPTIONS
PARAMONTE_COMPILER_VERSION
paramonte_type
getBaseName
getDirName

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 154 of file pm_paramonte.F90.

◆ PARAMONTE_COMPILER_VERSION

character(*, SK), parameter pm_paramonte::PARAMONTE_COMPILER_VERSION = compiler_version()

The scalar constant of type character of default kind SK, containing the version of the compiler with which the ParaMonte library has been built.

See also: paramonte
PARAMONTE_WEB_DOC
PARAMONTE_WEB_ISSUES
PARAMONTE_WEB_REPOSITORY
PARAMONTE_COMPILER_OPTIONS
PARAMONTE_COMPILER_VERSION
paramonte_type
getBaseName
getDirName

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 133 of file pm_paramonte.F90.

◆ PARAMONTE_SPLASH

character(*, SK), parameter pm_paramonte::PARAMONTE_SPLASH = NLC//NLC// SK_"ParaMonte"//NLC// SK_"Parallel Monte Carlo and"//NLC// SK_"Machine Learning Library"//NLC// NLC// SK_"Version "//PARAMONTE_VERSION//NLC// NLC// SK_"Build: "//PARAMONTE_BUILD_DATE//NLC// NLC// SK_"Developed by"//NLC// NLC// SK_"The computational Data Science Lab"//NLC// NLC// SK_"at"//NLC// NLC// SK_"Division of Data Science"//NLC// SK_"Department of Physics & Astronomy"//NLC// SK_"The University of Texas at Arlington"//NLC// NLC// SK_"Multiscale Modeling Group"//NLC// SK_"Center for Computational Oncology"//NLC// SK_"Oden Institute for Computational Engineering and Sciences"//NLC// SK_"Department of Aerospace Engineering and Engineering Mechanics"//NLC// SK_"Department of Neurology, Dell-Seton Medical School"//NLC// SK_"Department of Biomedical Engineering"//NLC// SK_"The University of Texas at Austin"//NLC// NLC// SK_"For questions and further information, please contact the PI:"//NLC// NLC// SK_"Amir Shahmoradi"//NLC// SK_"shahmoradi@utexas.edu"//NLC// SK_"cdslab.org/pm"//NLC// NLC//NLC

The public scalar character constant of default kind SK containing the ParaMonte splash information.

The splash information includes the following items,

The library name.
The library version.
The library build date.
The developing organization name.
The developing organization affiliations.
The project PI contact information.
The project GitHub web address.

Possible calling interfaces ⛓

: use pm_paramonte, only: PARAMONTE_SPLASH

print *, PARAMONTE_SPLASH

pm_paramonte::PARAMONTE_SPLASH
character(*, SK), parameter PARAMONTE_SPLASH
The public scalar character constant of default kind SK containing the ParaMonte splash information.
Definition: pm_paramonte.F90:507

See also: PARAMONTE_SPLASH
PARAMONTE_VERSION
PARAMONTE_BUILD_DATE
getParaMonteSplash

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK

4 use pm_io, only: display_type

5 use pm_paramonte, only: PARAMONTE_SPLASH

6

7 implicit none

8

9 type(display_type) :: disp

10 disp = display_type(file = "main.out.F90")

11

12 call disp%skip()

13 call disp%show("PARAMONTE_SPLASH")

14 call disp%show( PARAMONTE_SPLASH , deliml = SK_"""" )

15 call disp%skip()

16

17end program example

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe

2set PATH=..\..\..\lib;%PATH%

3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe

4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example output ⛓
1

2PARAMONTE_SPLASH

3"

4

5ParaMonte

6Parallel Monte Carlo and

7Machine Learning Library

8

9Version 2.0.0

10

11Build: Thu Nov 7 13:37:00 2024

12

13Developed by

14

15The computational Data Science Lab

16

17at

18

19Department of Physics

20Data Science Program, College of Science

21The University of Texas at Arlington

22

23Multiscale Modeling Group

24Center for Computational Oncology

25Oden Institute for Computational Engineering and Sciences

26Department of Aerospace Engineering and Engineering Mechanics

27Department of Neurology, Dell-Seton Medical School

28Department of Biomedical Engineering

29The University of Texas at Austin

30

31For questions and further information, please contact the PI:

32

33Amir Shahmoradi

34shahmoradi@utexas.edu

35cdslab.org/pm

36

37

38"

39

40

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas Austin

Definition at line 507 of file pm_paramonte.F90.

Referenced by getParaMonteSplash().

◆ PARAMONTE_VERSION

character(*, SK), parameter pm_paramonte::PARAMONTE_VERSION = __PARAMONTE_VERSION__

The public scalar character constant of default kind SK containing the ParaMonte library version.

The generated version is the value reported in the VERSION.md in the root directory of the ParaMonte library git repository.

Possible calling interfaces ⛓

: use pm_paramonte, only: PARAMONTE_VERSION

print *, PARAMONTE_VERSION

pm_paramonte::PARAMONTE_VERSION
character(*, SK), parameter PARAMONTE_VERSION
The public scalar character constant of default kind SK containing the ParaMonte library version.
Definition: pm_paramonte.F90:453

See also: PARAMONTE_SPLASH
PARAMONTE_VERSION
PARAMONTE_BUILD_DATE
getParaMonteSplash

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK

4 use pm_io, only: display_type

5 use pm_paramonte, only: PARAMONTE_VERSION

6

7 implicit none

8

9 type(display_type) :: disp

10 disp = display_type(file = "main.out.F90")

11

12 call disp%skip()

13 call disp%show("PARAMONTE_VERSION")

14 call disp%show( PARAMONTE_VERSION , deliml = SK_"""" )

15 call disp%skip()

16

17end program example

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe

2set PATH=..\..\..\lib;%PATH%

3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe

4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example output ⛓
1

2PARAMONTE_VERSION

3"2.0.0"

4

5

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas Austin

Definition at line 453 of file pm_paramonte.F90.

◆ PARAMONTE_WEB_DOC

character(*, SK), parameter pm_paramonte::PARAMONTE_WEB_DOC = SK_"https://www.cdslab.org/paramonte/"

The scalar constant of type character of default kind SK, containing the web portal address for reporting the ParaMonte library issues.

See also: paramonte
PARAMONTE_WEB_DOC
PARAMONTE_WEB_ISSUES
PARAMONTE_WEB_REPOSITORY
PARAMONTE_COMPILER_OPTIONS
PARAMONTE_COMPILER_VERSION
paramonte_type
getBaseName
getDirName

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 110 of file pm_paramonte.F90.

◆ PARAMONTE_WEB_ISSUES

character(*, SK), parameter pm_paramonte::PARAMONTE_WEB_ISSUES = SK_"https://github.com/cdslaborg/paramonte/issues"

The scalar constant of type character of default kind SK, containing the web portal address for reporting the ParaMonte library issues.

See also: paramonte
PARAMONTE_WEB_DOC
PARAMONTE_WEB_ISSUES
PARAMONTE_WEB_REPOSITORY
PARAMONTE_COMPILER_OPTIONS
PARAMONTE_COMPILER_VERSION
paramonte_type
getBaseName
getDirName

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 89 of file pm_paramonte.F90.

◆ PARAMONTE_WEB_REPOSITORY

character(*, SK), parameter pm_paramonte::PARAMONTE_WEB_REPOSITORY = SK_"https://github.com/cdslaborg/paramonte"

The scalar constant of type character of default kind SK, containing the web portal address for the ParaMonte library repository.

See also: paramonte
PARAMONTE_WEB_DOC
PARAMONTE_WEB_ISSUES
PARAMONTE_WEB_REPOSITORY
PARAMONTE_COMPILER_OPTIONS
PARAMONTE_COMPILER_VERSION
paramonte_type
getBaseName
getDirName

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Amir Shahmoradi, September 1, 2017, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 68 of file pm_paramonte.F90.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ getParaMonteSplash()

Variable Documentation

◆ envis

◆ envname

◆ paramonte

◆ PARAMONTE_BUILD_DATE

◆ PARAMONTE_COMPILER_OPTIONS

◆ PARAMONTE_COMPILER_VERSION

◆ PARAMONTE_SPLASH

◆ PARAMONTE_VERSION

◆ PARAMONTE_WEB_DOC

◆ PARAMONTE_WEB_ISSUES

◆ PARAMONTE_WEB_REPOSITORY