https://github.com/lobis/gas-cli

A simple CLI for Garfield++ to generate .gas files
https://github.com/lobis/gas-cli

Last synced: 6 days ago
JSON representation

A simple CLI for Garfield++ to generate .gas files

• Host: GitHub
• URL: https://github.com/lobis/gas-cli
• Owner: lobis
• Created: 2022-09-28T10:01:29.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T20:11:05.000Z (almost 2 years ago)
• Last Synced: 2023-03-11T19:16:29.253Z (over 1 year ago)
• Language: C++
• Size: 147 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gas-cli

[![Build](https://github.com/lobis/gas-generator/actions/workflows/build.yml/badge.svg)](https://github.com/lobis/gas-generator/actions/workflows/build.yml)

`gas-cli` is a command line tool for generating, merging or

reading [Garfield++](https://gitlab.cern.ch/garfield/garfieldpp) gas files.

## Installation

[ROOT](https://github.com/root-project/root) is required as it is a dependency of Garfield itself even though it's not

really needed for this project.

If you know a way of removing this dependency, please contact me or post and issue with your suggestion.

Garfield is not a required dependency as the CMake configuration will build it from source if its not found on the

system. This is not practical for ROOT as it's a very large dependency.

Use CMake to build and install the project (run commands at the root of the project):

```

cmake -S . -B build

cmake --build build

cmake --install build

```

## Command Line Interface

A full list of commands can be retrieved via

```gas-cli --help```

### Generating a gas file

A gas file can be generated from the command line parameters using the `generate` subcommand.

```

gas-cli generate --components C4H10 2.3 Ar -o /tmp/test.gas --electric-field-log 1 1000 10

```

multiple electric field configurations (linear, log, points) can be defined at once.

Close points are discarded according to predefined tolerances. The command below will produce 200 entries.

```

gas-cli generate --components Ar 48.85 Xe 48.85 C4H10 --pressure 1.0 --efield-lin 0 1000 110 --efield-log 0.1 1000 107 --collisions 10

```

### Reading a gas file

A gas file can be read and a json containing some useful gas properties can be generated using the `read` subcommand.

```

gas-cli read -i input.gas -o output.json

```

### Merging multiple gas files

Multiple gas files can be combined into one using the `merge` subcommand.

```

gas-cli merge -i file1.gas file2.gas file3.gas -o merge.gas

```

## Docker image

A docker image is available as a [GitHub package](https://github.com/lobis/gas-generator/pkgs/container/gas-cli).

```

docker run --rm --pull=always ghcr.io/lobis/gas-cli --help

```

To run a gas simulation and save it to a local directory you can use the following command:

```

docker run -d --rm --pull=always --mount type=bind,source=/tmp/gases,target=/output ghcr.io/lobis/gas-cli generate --components Ar 48.85 Xe 48.85 C4H10 --dir /output --pressure 1.0 --efield-lin 0 1000 110 --efield-log 0.1 1000 107

```