Skip to content

Commit

Permalink
2nd pass on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
donaldcampbelljr committed Nov 9, 2023
1 parent 59e0d27 commit 6f0de75
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 471 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.

## [1.6.0] -- 2023-11-xx
## [1.6.0] -- 2023-11-10

### Added
- `looper link` creates symlinks for results grouped by record_identifier. It requires pipestat to be configured. [#72](https://github.com/pepkit/looper/issues/72)
Expand Down
2 changes: 1 addition & 1 deletion docs/pipestat.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Now, Looper will obtain pipestat configurations data from two sources:
1. pipeline interface
2. looper_config file

Looper will combine the necessary configuration data and write a new pipestat configuration file named `looper_pipestat_config.yaml` which looper will place in its output directory. Pipestat then uses this configuration file to create the required pipestatManager objects. See [Hello_Looper](https://github.com/pepkit/hello_looper) for a specific example.
Looper will combine the necessary configuration data and write a new pipestat configuration file named `looper_pipestat_config.yaml` which looper will place in its output directory. Pipestat then uses this configuration file to create the required PipestatManager objects. See [Hello_Looper](https://github.com/pepkit/hello_looper) for a specific example.

Briefly, the Looper config file must contain a pipestat field. A project name must be supplied if running a project level pipeline. The user must also supply a file path for a results file if using a local file backend or database credentials if using a postgresql database backend.

Expand Down
4 changes: 2 additions & 2 deletions docs/running-a-pipeline.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# How to run a pipeline

You first have to [define your project](defining-a-project.md). This will give you a PEP linked to a pipeline. Next, we'll run the pipeline.
You first have to [define your project](defining-a-project.md) and a [config file](looper-config.md). This will give you a PEP linked to a pipeline. Next, we'll run the pipeline.

The basic command is `looper run`. To run your pipeline, just:

```console
looper run project_config.yaml
looper run --looper-config .your_looper_config.yaml
```

This will submit a job for each sample. That's basically all there is to it; after this, there's a lot of powerful options and tweaks you can do to control your jobs. Here we'll just mention a few of them.
Expand Down
6 changes: 3 additions & 3 deletions docs/variable-namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ So, the compute namespace is first populated with any variables from the selecte

The `pipestat` namespace conists of a group of variables that reflect the [pipestat](http://pipestat.databio.org) configuration for a submission.

1. results_file (`PipestatManager.file`)
2. record_id (`PipestatManager.record_identifier`)
3. config (`PipestatManager.config_path`)
1. results_file (`pipestat.file`)
2. record_id (`pipestat.record_identifier`)
3. config (`pipestat.config_path`)

## Mapping variables to submission templates using divvy adapters

Expand Down

0 comments on commit 6f0de75

Please sign in to comment.