This repository contains a YAML configuration file (form.yml) for launching a code-server environment on the Brain Image Library (BIL) cluster, enabling web-based coding and development tasks.
The form.yml file defines a form-based interface for configuring a Slurm job to run a code-server session on the BIL cluster. Users can specify parameters such as the code-server version, working directory, CPU cores, memory allocation, and additional Slurm options to tailor the session to their needs.
The configuration file (form.yml) includes the following key sections:
Title and Cluster: Specifies the application name (Codeserver) and the target cluster (bil). Description: Briefly describes the application as launching a code-server environment for web-based coding and development. Form: Lists the input fields for the user interface: account bc_num_hours working_dir version bc_queue bc_num_cores bc_memory extra_slurm_args (last in the list for advanced customization).
Attributes: Defines properties and constraints for key fields: version: Selects the code-server version (4.8.3, with 3.9.3 commented out). working_dir: Chooses a project directory (defaults to $HOME). bc_queue: Defaults to "applications". account: Set to "null". bc_num_cores: Sets 4–64 CPU cores (steps of 1, default: 4). bc_memory: Allocates 8–2900 GB of memory (steps of 1, default: 8). extra_slurm_args: Allows additional Slurm parameters.
Codeserver Version: Choose version 4.8.3 (3.9.3 available but commented out). Working Directory: Select a project directory, defaulting to the user's home directory. Number of Cores: Configurable from 4 to 64 cores to balance performance and resource usage. Memory Allocation: Ranges from 8 GB to 2900 GB for resource-intensive development tasks. Queue: Defaults to the "applications" queue. Extra Slurm Args: Allows advanced Slurm job customization.
Clone this repository to your local environment or cluster. Ensure the BIL cluster supports the Slurm workload manager and code-server software. Modify form.yml if needed (e.g., adjust defaults or uncomment additional version options). Use the YAML configuration with a compatible job submission system (e.g., Open OnDemand) to launch the code-server session. Configure parameters via the form interface to allocate resources and start the session.
Ensure resource allocations (cores, memory) are appropriate to avoid overloading the cluster. The bc_num_hours field lacks attributes; consider adding constraints (e.g., 1–8 hours) for consistency. Use extra_slurm_args for advanced Slurm configurations, as it is the last field for flexibility.
Copyright © 2025 Pittsburgh Supercomputing Center. All Rights Reserved.
The Biomedical Applications Group at the Pittsburgh Supercomputing Center in the Mellon College of Science at Carnegie Mellon University.