Content

• Calculation
  1. Calculation steps
• Input
  1. Input types
  2. Input rules
• External files
• Validation
  1. Input validation
  2. Validation script
• Results
  1. Start- and endtags
  2. Single line tags
  3. Show file or image
  4. Generate PDF with LaTeX

Calculation

Calculation steps

A calculation will try to run main_function with the provided input in a dictionnary called input_dict. Optionnaly, a validation script can be ran prior to executing the main script. If the script ran succesfully, a pdf document can be created using a LaTeX script.

Input

A calculation comes with a form where the user can provide input according to the input settings. This will result in a python dictionnary that can be used in the python scripts.

Input Types

The type of input defines the form-element that is used and in which type object the input is stored and passed to the python script. Some input types require predefined input. A dropdown for example needs to have a set of option from wich the user can choose.

Predefined input

For some input types, a selection of options need to be predefined. This is done with a JSON script. The JSON script needs to contain a list of choices. Every choice should have an id, name and optionally another list of choices. The id is passed to the python dictionary if that name is selected. The deepest level does not contain choices, but only id and name. For translation, name_XX can be used with XX being the language code.

{
  "choices": [
    {
      "id": "a",
      "name": "Option A"
    },
    {
      "id": "b",
      "name": "Option B"
    },
    {
      "id": "c",
      "name": "Option C"
    },
    {
      "id": "d",
      "name": "Option D"
    }
  ]
}

{
  "choices": [
    {
      "id": "a",
      "name": "Main: A",
      "name_nl": "Hoofd: A",
      "choices": [
        {
          "id": "a_1",
          "name": "Second: A1",
          "name_nl": "Tweede: A1",
          "choices": [
            {
              "id": "a_11",
              "name": "Third: A1.1",
              "name_nl": "Derde: A1.1"
            },
            {
              "id": "a_12",
              "name": "Third: A1.2",
              "name_nl": "Derde: A1.2"
            }
          ]
        },
        {
          "id": "a_2",
          "name": "Second: A2",
          "name_nl": "Tweede: A2",
          "choices": [
            {
              "id": "a_21",
              "name": "Third: A2.2",
              "name_nl": "Derde: A2.2"
            },
            {
              "id": "a_22",
              "name": "Third: A2.2",
              "name_nl": "Derde: A2.2"
            }
          ]
        }
      ]
    },
    {
      "id": "b",
      "name": "Main: B",
      "name_nl": "Hoofd: B",
      "choices": [
        {
          "id": "b_1",
          "name": "Second: B1",
          "name_nl": "Tweede: B1",
          "choices": [
            {
              "id": "b_11",
              "name": "Third: B1.1",
              "name_nl": "Derde: B1.1"
            },
            {
              "id": "b_22",
              "name": "Third: B1.2",
              "name_nl": "Derde: B1.2"
            }
          ]
        },
        {
          "id": "b_2",
          "name": "Second: B2",
          "name_nl": "Tweede: B2",
          "choices": [
            {
              "id": "b_21",
              "name": "Third: B2.1",
              "name_nl": "Derde: B2.1"
            },
            {
              "id": "b_22",
              "name": "Third: B2.2",
              "name_nl": "Derde: B2.2"
            }
          ]
        }
      ]
    }
  ]
}

Mathematical operators

Mathematical operators can be assigend to an input field to create an extra dropdown where the user can choose if the value needs to be interpreted as a minimal or maximal value for example. An extra key and value will be added to the dictionnary. The key in this dictionary is the CID of the parameter appended with _operator

Validation

If validation is set in the input settings, the user will be notified if the input is not correct before the calculation will run.

• Required
• Minimum value
• Maximum value

Input Rules

Validation

Input validation

Validtion script

External files

External files can be uploaded in the admin console Caclulator > Upload files. Select your platform and calculation(s) that are aloud to use this file.

Once external files are uploaded, you can add them to your calculation under USE EXTERNAL FILES

In your Python code, the file can be opened like it would be in the same directory as the python script itself. For example:

import csv


with open('example_file.csv') as csv_file:
    csv_reader = csv.reader(csv_file, delimiter=',')
    line_count = 0

    for row in csv_reader:
        print(row)
        line_count += 1

Output

All statements printed while executing the python script are treated as output. There are some special tags that you could use to format the output text. Characters as & <, >, " and ' are escaped when formatting the output as HTML. The newline character is not escaped, so to start a new line: print \n. To escape the newline character, print \\n.

Start- and end-tags

There are some tags that translate to specific HTML. Start- and end tags can be used to format text in between te tags. If only a start-tag is used, all the following text will be formatted according to the tag. Likewise, if only an end-tag is used, all the previous output is formatted. Start- and end-tags are written in lowercase within an underscore and an open or close bracket like _tag[

multiple lines
of code

Single line tags

Single line tags are written in lowercase within an underscore and a space like _single_line_tag .... The following line up to a newline character is formatted according to the tag. You can use start- and end-tags within each other and within aa single line tag.

Show file or image

If your python script creates a file, you can show a download link as ouptut or show a responsive image if the file is an image.

Generate PDF with LaTeX

If a LaTeX script is provided, a PDF will be created after the python function is finished. The PDF can be downloaded or sent by mail.

Tex file from template

You can specify a tex-file as a template in each available language in the admin console. This template can be modified with print statements from your python script. Print statements with _latex tags will be inserted in the .tex file before the PDF is compiled. Use the tag _latex_line or _latex_line99 where 99 is a positive integer.

Tex file generated by python script

If your python script generates a .tex file, you can set the name of the file in the admin console and the .tex file will be compiled aftere executing the python code.