Looper uses YAML configuration files for several purposes. Looper is designed to be organized, modular, and very configurable, so there are several configuration files. We’ve organized the configuration files so they each handle a different level of infrastructure: environment, project, sample, or pipeline. This makes the system very adaptable and portable, but for a newcomer, it is easy to confuse what the different configuration files are used for. So, here’s an explanation of each for you to use as a reference until you are familiar with the whole ecosystem. Which ones you need to know about will depend on whether you’re a pipeline user (running pipelines on your project) or a pipeline developer (building your own pipeline).
Users (non-developers) of pipelines only need to be aware of one or two YAML files:
- project config file: This file is specific to each project and contains information about the project’s metadata, where the processed files should be saved, and other variables that allow to configure the pipelines specifically for this project. This file follows the standard looper format (now referred to as
If you are planning to submit jobs to a cluster, then you need to know about a second YAML file:
- PEPENV environment config: This file tells looper how to use compute resource managers, like SLURM. This file doesn’t require much editing or maintenance beyond initial setup.
That should be all you need to worry about as a pipeline user. If you need to adjust compute resources or want to develop a pipeline or have more advanced project-level control over pipelines, then you’ll need to know about a few others:
If you want to add a new pipeline to looper, tweak the way looper interacts with a pipeline for a given project, or change the default cluster resources requested by a pipeline, then you need to know about a configuration file that coordinates linking your pipeline in to your looper project.
- pipeline interface file: Has two sections: 1)
protocol_mappingtells looper which pipelines exist, and how to map each protocol (sample data type) to its pipelines; 2)
pipelineslinks looper to the pipelines by describing options, arguments, and compute resources that the pipeline needs to run.
Finally, if you’re using Pypiper to develop pipelines, it uses a pipeline-specific configuration file (detailed in the Pypiper documentation):
- Pypiper pipeline config file: Each pipeline may (optionally) provide a configuration file describing where software is, and parameters to use for tasks within the pipeline. This configuration file is by default named identical to the pypiper script name, with a .yaml extension instead of .py (So rna_seq.py looks for an accompanying rna_seq.yaml file by default). These files can be changed on a per-project level using the pipeline_config section in your project config file.