User Tools

Site Tools


documentation:optional_controls_keywords

Reference: A RESTful API for exchanging materials data in the AFLOWLIB.org consortium Computational Materials Science, Volume 93, October 2014, Pages 178-192 Richard H. Taylor, Frisco Rose, Cormac Toher, Ohad Levy, Kesong Yang, Marco Buongiorno Nardelli, Stefano Curtarolo http://www.sciencedirect.com/science/article/pii/S0927025614003322

aflowlib_entries

  • aflowlib_entries

Description: For projects and set-layer entries, aflowlib_entries lists the available sub-entries which are associated with the $aurl of the subdirectories.

Type: Set of strings separated by “,”

Example: aflowlib_entries=AgAl,AgAs,AgAu,AgB_h,AgBa_sv,AgBe_sv,AgBi_d,AgBr,AgCa_sv,

Request syntax: $aurl/?aflowlib_entries

aflowlib_entries_number

  • aflowlib_entries_number

Description: For projects and set-layer entries, aflowlib_entries lists the available sub-entries which are associated with the $aurl of the subdirectories. By parsing $aurl/?aflowlib_entries (containing $aurl/aflowlib_entries_number entries) the user finds the further locations to interrogate.

Type: number

Example: aflowlib_entries_number=1524

Request syntax: $aurl/aflowlib_entries_number

aflowlib_date

  • aflowlib_date

Description: Returns the date of the AFLOW post-processor which generated the entry for the library. This entry is useful for debugging and regression purposes.

Type: string

Example: aflowlib_date=20140204_13:10:39_GMT-5

Request syntax: $aurl/?aflowlib_date

aflow_version

  • aflow_version

Description: Returns the version number of AFLOW used to perform the calculation. This entry is useful for debugging and regression purposes.

Type: string

Example: aflow_version=aflow30641

Request syntax: $aurl/?aflow_version

author

  • author

Description: Returns the name (not necessarily an individual) and affiliation associated with authorship of the data. Multiple entries are separated by commas. Spaces are substituted with “_” to aid parsing.

Type: List of strings separated by “,”

Example: author=Marco_Buongiorno_Nardelli,Ohad_Levy,Jesus_Carrete

Request syntax: $aurl/?author

calculation_cores

  • calculation_cores

Description: Number of processors/cores, maximum memory, total time used for the calculation.

Type: number

Units: adimensional

Example: calculation_cores=32

Request syntax: $aurl/?calculation_cores

calculation_memory

  • calculation_memory

Description: Maximum memory used for the calculation.

Type: number

Units: Megabytes

Example: calculation_memory=8376.13

Request syntax: $aurl/?calculation_memory

calculation_time

  • calculation_time

Description: Total time used for the calculation.

Type: number

Units: seconds

Example: calculation_time=140713

Request syntax: $aurl/?calculation_time

corresponding

  • corresponding

Description: Returns the name (not necessarily an individual) and affiliation associated with the data origin concerning correspondence about data. Multiple entries are separated by commas. Spaces are substituted with “_” to aid parsing.

Type: List of strings separated by “,”

Example: corresponding=M_Buongiorno_Nardelli_mbn@unt.edu

Request syntax: $aurl/?corresponding

data_source

  • data_source

Description: The layered structure of AFLOWLIB adapts to serve and translate data presented in other open databases. If this is the case, the source and language (API) of the data are given with these two keywords. When using non-AFLOWLIB data, due diligence is required to recognize the authorship of the original work, and not the serving database, merely.

Type: strings

Example: data_source=aflowlib

Request syntax: $aurl/?data_source

data_language

  • data_language

Description: The layered structure of AFLOWLIB adapts to serve and translate data presented in other open databases. If this is the case, the source and language (API) of the data are given with these two keywords. When using non-AFLOWLIB data, due diligence is required to recognize the authorship of the original work, and not the serving database, merely.

Type: strings

Example: data_language=translated

Request syntax: $aurl/?data_language

loop

  • loop

Description: Informs the user of the type of post-processing that was performed.

Type: List of strings separated by “,”

Example: loop=thermodynamics,bands,magnetic

Request syntax: $aurl/?loop

node_CPU_Cores

  • node_CPU_Cores

Description: Information about the node/cluster where the calculation was performed. Number of cores accessible to the calculation.

Type: number

Example: node_CPU_Cores=12

Request syntax: $aurl/?node_CPU_Cores

node_CPU_MHz

  • node_CPU_MHz

Description: Information about the speed of the node/cluster where the calculation was performed.

Type: number

Units: MHz

Example: node_CPU_MHz=2661

Request syntax: $aurl/?node_CPU_MHz

node_CPU_Model

  • node_CPU_Model

Description: Information about the model of the node/cluster where the calculation was performed.

Type: string

Example: node_CPU_Model=Intel(R)_Xeon(R)_CPU_X5650_@_2.67GHz

Request syntax: $aurl/?node_CPU_Model

node_RAM_GB

  • node_RAM_GB

Description: Information about the total memory accessible to the calculation in the node/cluster where the calculation was performed.

Type: number

Units: Gigabytes

Example: node_RAM_GB=48

Request syntax: $aurl/?node_RAM_GB

  • sponsor

Description: Returns information about funding agencies and other sponsors for the data. Multiple entries are separated by commas. Spaces are substituted with “_” to aid parsing.

Type: List of strings separated by “,”

Example: sponsor=DOD_N000141310635,NIST_70NANB12H163

Request syntax: $aurl/?sponsor

documentation/optional_controls_keywords.txt · Last modified: 2014/11/06 14:19 by allison