Versions Compared

Old Version 5

changes.mady.by.user Unknown User (plgtomgra)

Saved on

compared with

New Version 6

changes.mady.by.user Bartłomiej Wenda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • scriptLanguage - name of the scripting language in which the application is written. Currently only one language is available:
    • MATLAB - MATLAB programming language. This applies also to Octave applications 
  • executableScriptName - name of the application executable file
  • functionName - name of main function used to execute the application
  • inputFiles (Optional*) - input files that are needed by the application. For each input file defined here, the application panel will show a button to choose the location of that file. When the application is run, the input files will be read into a MATLAB variables and passed as arguments to the main executable function in the order in which they appear here.  Each input file is defined by: 
    • dataType - data type of the input (see Data Types section below)
    • typeLabel (Optional*) - a name distinguishing this input file from others. Allows to have multiple input files with the same data type. Each input file with different type label will be treated as a separate input and be passed to the main function as a separate argument  
    • multiplicity multiplicity (Optional* - by default set to 1 if field is not present in the file) - how many inputs of that type are expected (written as string value). Defines minimum required number and maximum allowed number of inputs. The portal validates if the user selected the correct number of input files, and if not, it will not allow the user to run the application. Depending on what multiplicity is given the input(s) might be passed to the main function in a different way (see Handling custom multiplicity in input files section). The possible values are:
      • ? -  zero or one. The input is optional, there can be at most one input file
      • * -  zero or more. The input is optional and there is no upper limit of how many input files there can be
      • + - one or more. At least one file is required and there is no upper limit of how many input files there can be
      • n - exactly n input files are expected - no more, no less  
      • [n, m] - there should be at least n input files and at most m input files
  • inputParameters (Optional*) - simple input parameters that should be entered by the user. For each parameter defined here, the application panel will show input form where the user can enter the value of the parameter. When the application is run, the parameters' values will be passed as arguments to the main executable function in the order in which they appear here. The parameter arguments are added after arguments specified by input files (see section Executable Script). When adding a parameter you have to specify what kind of value it should have. The available options are:
    • TEXT - a text value
    • BOOLEAN - a true or false value
    • DOUBLE - a real number value
    • INTEGER - an integer value
    • TIME - a date value
      The screen-shot below shows how the input parameters will appear when they are presented as input forms in the application panel

...

  • shortName (Required) - short name of the application. The short name will be used for creating application directory within the workspace. It is not recommended to include special characters in the application name, some of them are not allowed
  • lastUpdate - a date when the application was last updated, written In format "dd-MM-yyyy HH:mm:ss"
  • references - links to additional resources that can be displayed with the application (e.g. user guide). It is a map where the key will be the text of the link and the value will be its web address (URL)
  • categories - categories to which the application can be assigned. It is advisable to use the categories already present within the portal. However, you can also add your own
  • keywords - keywords that match the application. If relevant, use the keywords already defined within the portal, but add also your own, to describe the application best
  • hidden - if this application should be visible in the EPISODES platform
  • name (Required) - full name of the application, that will be visible on the application list. May contain spaces.
  • description - longer description of the application. May contain HTML tags, including links. May also include the input or output type name written as ${D__data_type}, where "data_type" is the data type of the input or output file - this will be filled with a full name of this data type that will be automatically translated into an appropriate language (if that translation is available)
  • license - license used for publishing the application. If you wish your application to be open to other users, include a license here. You might also include it as a LICENCE.txt file in your code repository
  • author - author of the application, may contain your name, institution and/or project affiliation.
  • citation - citations (articles) related to the application (e.g. the algorithms it uses). A generic portal and its application part is added to the citations, therefore, include here only citations related solely to this application.
  • inputsDescription - description of the application inputs. May contain HTML tags, including links. By default it should include listing of the types of inputs, but adding more detailed translations - a map that contains translations of descriptions that are subject to internationalization. The key of the map is the language of the translation written as a two letter language code, e.g. "en", or "pl" and the value contains the translated descriptions written in that language. There should be at least one language present - "en". The available description fields are: 
  • name (Required) - full name of the application, that will be visible on the application list. May contain spaces.
  • description - longer description of the application. May contain HTML tags, including links. May also include the input or output type name written as ${D__data_type}, where "data_type" is the data type of the input or output file - this will be filled with a full name of this data type that will be automatically translated into an appropriate language (if that translation is available)
  • license - license used for publishing the application. If you wish your application to be open to other users, include a license here. You might also include it as a LICENCE.txt file in your code repository
  • author - author of the application, may contain your name, institution and/or project affiliation.
  • citation - citations (articles) related to the application (e.g. the algorithms it uses). A generic portal and its application part is added to the citations, therefore, include here only citations related solely to this application.
    • inputsDescription - description of the application inputs. May contain HTML tags, including links. By default it should include listing of the types of inputs, but adding more detailed description is advisable. Input types should be written as ${D__data_type}, where "data_type" is the data type of the input file
  • resultsDescription - description of the application results. May contain HTML tags, including links. By default it should include listing of the types of outputs, but adding more detailed description is advisable. Output types should be written as ${D__data_type}, where "data_type" is the data type of the output file
  • computationalCharacteristic - description of the features of the application that might have impact on its computation time or other resources consumption.

Sample file

...

languagejs

...

  • should be written as ${D__data_type}, where "data_type" is the data type of the output file
  • computationalCharacteristic - description of the features of the application that might have impact on its computation time or other resources consumption.

Sample file

Code Block
languagejs
{
  "shortName":"AppDirtypes} and <a href='#app:AppId'>links</a>.",
      "license":"Sample licence",
      "author":"Sample author",
      "citationreferences":"Sample citations",
  {
    "inputsDescription":"${D__data_type}",
      "resultsDescription":"${D__other_data_type}User Guide":"https://docs.cyfronet.pl/pages/viewpage.action?pageId=somepage"
  },
  "lastUpdate":"28-02-2021 20:50:12",
  "categories":[
    "computationalCharacteristic":"Description of computational characteristic"Category"
  ],
  "keywords":[
    }"keyword1",
    "plkeyword2":{
    ],
  "name":"AplikacjaApplication name",
      "description":"DłuższyLonger description opiscontaining zsome ${D__data_types} iand <a href='#app:AppId'>linkiem<>links</a>.",
      "license":"LicencjaSample licence",
      "author":"AutorSample author",
      "citation":"RerefencjeSample do artykułówcitations",
      "inputsDescription":"${D__data_type}",
      "resultsDescription":"${D__other_data_type}",
      "computationalCharacteristic":"OpisDescription of charakterystykicomputational obliczeniowej"
    }
  }characteristic"
}

Other Files

You are free to add any other files to the repository if you wish. You can, for example, include additional script files to help better organize the code, or you can add some supplementary files like a readme or a license file.

...