form.yml.erb

# Batch Connect app configuration file
#
# @note Used to define the submitted cluster, title, description, and
#   hard-coded/user-defined attributes that make up this Batch Connect app.
---

# **MUST** set cluster id here that matches cluster configuration file located
# under /etc/ood/config/clusters.d/*.yml
# @example Use the Owens cluster at Ohio Supercomputer Center
#     cluster: "owens"
cluster: "puhti"

# Define attribute values that aren't meant to be modified by the user within
# the Dashboard form
attributes:
  # Set the corresponding modules that need to be loaded for Jupyter to run
  #
  # @note It is called within the batch job as `module load <modules>` if
  #   defined
  # @example Do not load any modules
  #     modules: ""
  # @example Using default python module
  #     modules: "python"
  # @example Using specific python module
  #     modules: "python/3.5"
  # @example Using combination of modules
  #     modules: "python/3.5 cuda/8.0.44"
  #modules: "python-env/2019.3"
  #bc_queue: "test" 

  # Any extra command line arguments to feed to the `jupyter notebook ...`
  # command that launches the Jupyter notebook within the batch job

  csc_slurm_partition:
    value: "interactive"
    select:
      - "interactive"
      - "small"
      - "gpu"
      - "gputest"
      - "test"
      - "fmi"
      - "fmitest"
    help: |
      Selecting a gpu partition will reserve 1 GPU (V100)
  csc_slurm_reservation:
    partitions:
      - "interactive"
      - "small"
      - "gpu"
      - "gputest"
      - "test"
      - "fmi"
      - "fmitest"
  csc_slurm_limits:
    data:
      limits:
        gpu:
          time: "8:00:00"
  python_module:
      label: Python
      widget: select
      options:
          - ["python-data"]
          - ["geoconda"]
          - ["pytorch"]
          - ["tensorflow"]
          - ["Custom module","Custom"]
          - ["Custom path","CustomPath"]
  custom_path:
    label: "Custom Python interpreter"
    widget: text_field
    value: ""
    wrapper:
      class: "custom_path"
    help: |
      Specify absolute path to python interpreter. 
      E.g `/scratch/project_12345/myInstall/bin/python`
  custom_module:
    widget: text_field
    label: "Custom Python module"
    value : ""
    wrapper:
      class: "custom_module"
    help: |
      Use a different Python module than the modules in the list. Leave empty to use the system Python. Virtual environment must be used when using system python.
  jp_type:
      widget: select
      label: "Jupyter type"
      options:
        - ["Notebook","notebook"]
        - ["Lab","lab", data-option-for-python-module-python-env: false]
      value: "notebook"
  csc_path:
    submit: notebook_dir
    label: "Working directory"
    paths:
      - "HOME"
      - "SCRATCH"
      - "PROJAPPL"
      - "/"
  advanced:
    label: "Show advanced settings"
    widget: check_box
    value: "0"
  python_user_site:
    widget: check_box
    label: "Enable user packages"
    value: "1"
    help: |
      Enables using packages installed to the user packages directory.
  python_user_base:
    widget: text_field
    label: "User packages path"
    value : ""
    wrapper:
      class: "advanced user_packages user_packages_field"
    help: |
      Path to a directory to install user packages in under `/scratch` or `/projappl`.
  enable_venv:
    widget: check_box
    label: "Use virtual environment"
    value: "0"
    help: |
      Create or use existing [virtual environment](https://docs.python.org/3/library/venv.html) based on selected module.
  venv:
    widget: text_field
    label: "Virtual environment path"
    value : ""
    wrapper:
      class: "advanced venv"
    help: |
      Path to a virtual environment under `/scratch/${your_project}` or `/projappl/${your_project}`. A new virtual environment will be created using `python -m venv <path>` if it does not exist.
  extra_jupyter_args:
    label: "Extra Jupyter args"
    value: ""
    wrapper:
      class: "advanced"
  csc_reset_cache:
    app: "sys/ood-base-jupyter"
  csc_extra_desc:
    desc: |
      <a href="https://docs.csc.fi/computing/webinterface/jupyter/" target="_blank">Documentation</a>

form:
  - csc_extra_desc
  - csc_slurm_reservation
  - csc_slurm_project
  - csc_slurm_partition
  - csc_header_resources
  - csc_cores
  - csc_memory
  - csc_nvme
  - csc_time
  - csc_header_settings
  - python_module
  - custom_module
  - custom_path
  - jp_type
  - csc_path
  - advanced
  - enable_venv
  - venv
  - python_user_site
  - python_user_base
  - extra_jupyter_args
  - csc_reset_cache
  - csc_slurm_limits