Skip to content

wenqiang-gu/wire-cell-python

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wire Cell Toolkit Python

What’s here.

This package holds some Python modules that support Wire Cell Toolkit. Currently this is a stand-alone package that does not depend directly on the C++ packages of WCT.

Some of the functionality provided includes converters and generators of major WCT input data files including:

  • field response functions
  • wire geometry
  • diagnostic plots

Installation

$ python3 -m venv venv
$ source venv/bin/activate
$ cd wire-cell-python
$ pip install -r requirements/base.txt
$ pip install -r requirements/img.txt
$ pip install -r requirements/sigproc.txt
$ pip install -e .

If you have trouble installing mayavi via pip consider installing it as a system package and then making the venv with:

$ python3 -m venv venv --system-site-packages

Use

In fresh shells must repeat:

$ source venv/bin/activate

Others

ZIO

The ZIO Python package can provide some functionality that WCT may make use of (flow/domo brokers). It’s installation is somewhat irregular so a script is provided to help. It will also install the wirecell Python module.

$ python3 -m venv venv
$ source venv/bin/activate
$ ./zioinst.sh

Command line interfaces

Each main wirecell.<module> exposes most of its functionality via a command line interface named wirecell-<module>. For example:

$ wirecell-sigproc --help
Usage: wirecell-sigproc [OPTIONS] COMMAND [ARGS]...

  Wire Cell Signal Processing Features

Options:
  --help  Show this message and exit.

Commands:
  convert-garfield              Convert an archive of a Garfield fileset...
  plot-garfield-track-response

If your shell supports it, see what commands are available with TAB completion:

$ wirecell-<TAB><TAB>

Documentation

In addition to the online -h/--help for main and sub commands, some notes on specific commands are in docs/.

About

Python modules in support of Wire Cell

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.3%
  • Shell 0.7%