dokan 1.0.0

Automating the NNLOJET workflow

dokan (土管)

 A pipeline for automating the NNLOJET workflow

---

Table of Contents

• Installation
• Usage
• License

This is the implementation of an automated workflow for NNLOJET computations based on the luigi framework.

Installation

Release version

todo: publish on pypi

Development version

To install the development version, first clone this repository

git clone https://github.com/aykhuss/dokan.git
cd dokan

You can either install the tool using pip or uv.

Install using pip

Within the repository directory, run (add --force-reinstall if necessary)

pip install -e .

This should install the nnlojet-run command for you.

Install using uv

uv is a modern and more powerful alternative to pip. dokan can be installed by running within the repository directory (add --force if necessary):

uv tool install -e .

With this, the nnlojet-run executable should be installed and available.

Usage

Some example usage:

# general help
nnlojet-run --help

### subcommand `init` 
#   to initialise a new run
#   
# help
nnlojet-run init --help

# take any runcard and use it to initialise a new run
nnlojet-run init example.run
# this will create a new folder under the current path named after the `RUN` name in the runcard
# or you can add `-o <RUN_PATH>` to specify a location where the run should be initialised

### subcommand `config` 
#   to re-configure default settings for a calculation
#   
nnlojet-run config example_run_Z_8TeV

### subcommand `submit` 
#   to submit a run
#   
# help
nnlojet-run submit --help

# submit jobs with default configuration as set during `init`/`config`
nnlojet-run submit example_run_Z_8TeV 

# you can override defaults by passing the desired settings as options, e.g.
nnlojet-run submit example_run_Z_8TeV --job-max-runtime 1h30m --jobs-max-total 10 --target-rel-acc 1e-2

Shell completion

Auto-completion for the nnlojet-run command is available for bash. It can be enabled, by running

source path/to/dokan/share/completion.sh

To enable completion on startup, put this line in ~/.bashrc.

License

dokan is distributed under the terms of the GPL-3.0 license.