Date: Thu, 28 Mar 2024 18:43:04 +0100 (CET) Message-ID: <1792279524.969.1711647784125@plg-s04> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_968_906369106.1711647784125" ------=_Part_968_906369106.1711647784125 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The Application Description is an optional file, that provides addit= ional information about your application. It could be especially important = if you share your application with other users and want them to understand = better the computation methods you used inside, or if you want to have a de= scription of the methods you use for yourself (e.g. for distinguishing betw= een different versions of the code).
The Application Description should always have the same name - appDescription.json and ha= s to be placed in the root (main) directory of your application's repositor= y. Otherwise, the system wouldn't be able to locate it.
The format of the file is JSON (pronounced Jason), a commonly used text fo= rmat for representing objects. When creating and editing the file, you must= take care to follow the format rules - e.g. closing brackets, using quotes= to enclose field names and text values, otherwise, we will not be able to = read the file and display your application. To validate the JSON structure,= you can use on-line tools, like https://jsonformatter.curiousconcept.com/ (allows = using comments) or https://jsonlint.c= om/ (features also some tips on how to write your JSON correctly).= The full specification of the format can be found at https://www.json.org/.
Excerpt 1. shows all the possible options that can be specified in the A=
pplication Description (appDescription.json) file, with a detail explanatio=
n following. Note, the use of curly brackets ('{}
') on opening=
and closing of complex structures (objects) and square brackets ('[]=
') on opening and closing of listings (arrays). The placement of the=
double quotes (""
) is also important, while the white spaces =
are ignored. Comments can be added either with double slash ('//') for single-line comments or with sequence
/* c=
omment */
for multi-line comment.
{ "dirName" : "<name of the directory that will be created for the appli= cation>", "name" : "<full name of the application>", "description" : "<longer description of the application>", "inputsDescription" : "<description of input files>", "resultsDescription" : "<description of result files>", "computationalCharacteristic" : "<description of the computational cha= racteristics of the code>", "author" : "<author name>", "license" : "<licence>", "citation" : "<citations>", "categories" : [ "<category>" ], "keywords":[ "<keyword1>", "<keyword2>" ], "references" : { "<name of the resource>" : "<link to the resource>" }, "lastUpdate" : "<last modification date>" }
Excerpt 1. Full structure of the&n= bsp;Application Description file
All the possible options are described below. All fields of the Applicat= ion Description file are optional - if you do not want to use them, just do= not add them to the file or put them in comments. If the fields are not sp= ecified, the values will be set to defaults or set to empty.
LICENCE.txt
file in your code repositoryExcerpt 2. contains a full description of a sample application (the desc= ription is compatible with the application from Example 2 in the Application Definition fi= le configuration guide). Figures 1-3 further show how the description e= lements are visible inside the EPISODES Platform.
{ "shortName" : "TestAppVectorOperations", "name" : "Test application: Vector Operations", "description" : "<p><b>NOTE: This is a test application demon= strating use or e-Research Platform functionalities, not meant for producti= on environment.</b></p><p>Tool for performing simple oper= ations on a given number vector.</p>", "inputsDescription" : "${D__double_vector}", "resultsDescription" : "${D__double_vector} after performing requested op= erations", "computationalCharacteristic" : "The computation time depends on the inpu= t vector, however, should not be longer than several seconds.", "author" : "ACC Cyfronet AGH", "license" : "Creative Commons Attribution-ShareAlike 4.0 International Li= cense: <a href=3D'https://creativecommons.org/licenses/by-sa/4.0/'>ht= tps://creativecommons.org/licenses/by-sa/4.0/</a>", "citation" : "Author, A., Author, B. et al. (2021). Article title and oth= er details", "categories" : [ "Test" ], "keywords" : [ "Vectors", "Testing" ], "references" : { "User Guide" : "https://docs.cyfronet.pl/display/ISDOC/Application+Desc= ription+file" }, "lastUpdate" : "24-11-2021" }
Excerpt 2. A description of a samp= le app
Figure 1. Elements of the Applicat= ion Description file displayed on the application list within the EPISODES = Platform
Figure 2. Elements of the App= lication Description file displayed on the application information page wit= hin the EPISODES Platform
Figure 3. Elements of the App= lication Description file displayed with the application in workspace withi= n the EPISODES Platform