|
2 | 2 |
|
3 | 3 | * What's here. |
4 | 4 |
|
5 | | -This package holds some Python modules that support Wire Cell Toolkit. |
6 | | -Currently this is a stand-alone package that does not depend directly |
7 | | -on the C++ packages of WCT. |
| 5 | +This package provides Python modules in the ~wirecell~ namespace as well as |
| 6 | +various ~wirecell-*~ command line programs. These support the Wire Cell Toolkit |
| 7 | +but do not depend on it. If this package is available during the WCT build |
| 8 | +process then some additonal unit tests can run using ~wirecell-*~ programs. |
8 | 9 |
|
9 | | -Some of the functionality provided includes converters and generators |
10 | | -of major WCT input data files including: |
| 10 | +Some of the functionality provided includes converters and generators of major |
| 11 | +WCT input data files including: |
11 | 12 |
|
12 | 13 | - field response functions |
13 | 14 | - wire geometry |
14 | 15 | - diagnostic plots |
15 | 16 |
|
16 | 17 | * Installation |
17 | 18 |
|
18 | | -#+BEGIN_EXAMPLE |
19 | | - $ python3 -m venv venv |
20 | | - $ source venv/bin/activate |
21 | | - $ cd wire-cell-python |
22 | | - $ pip install -r requirements/base.txt |
23 | | - $ pip install -r requirements/img.txt |
24 | | - $ pip install -r requirements/sigproc.txt |
25 | | - $ pip install -e . |
26 | | -#+END_EXAMPLE |
| 19 | +It is recommended to use [[https://github.com/astral-sh/uv][uv]] for user and developer tasks. |
27 | 20 |
|
28 | | -If you have trouble installing ~mayavi~ via ~pip~ consider installing it |
29 | | -as a system package and then making the ~venv~ with: |
| 21 | +** User |
| 22 | + |
| 23 | +The package is not yet available in PyPI but the command line programs can be used like: |
30 | 24 |
|
31 | 25 | #+begin_example |
32 | | - $ python3 -m venv venv --system-site-packages |
| 26 | +uv run --with git+https://github.com/wirecell/wire-cell-python wirecell-util --help |
33 | 27 | #+end_example |
34 | 28 |
|
35 | | -If you have trouble installing ~gojsonnet~ via ~pip~ consider replacing it |
36 | | -to ~jsonnet~ in requirements/base.txt and setup.py. In addition, commenting |
37 | | -out ~moo~ in setup.py might also help decouple with ~gojsonnet~ |
38 | | - |
39 | | -* Use |
40 | | - |
41 | | -In fresh shells must repeat: |
42 | | - |
43 | | -#+BEGIN_EXAMPLE |
44 | | - $ source venv/bin/activate |
45 | | -#+END_EXAMPLE |
46 | | - |
47 | | -* Others |
48 | | - |
49 | | - |
50 | | -** ZIO |
51 | | - |
52 | | -The ZIO Python package can provide some functionality that WCT may |
53 | | -make use of (flow/domo brokers). It's installation is somewhat |
54 | | -irregular so a script is provided to help. It will also install the |
55 | | -~wirecell~ Python module. |
| 29 | +** Developer |
56 | 30 |
|
57 | 31 | #+begin_example |
58 | | - $ python3 -m venv venv |
59 | | - $ source venv/bin/activate |
60 | | - $ ./zioinst.sh |
| 32 | +git clone [email protected]:WireCell/wire-cell-python.git |
| 33 | +cd wire-cell-python |
| 34 | +uv sync |
| 35 | +uv run wirecell-util --help |
61 | 36 | #+end_example |
62 | 37 |
|
| 38 | + |
63 | 39 | * Command line interfaces |
64 | 40 |
|
65 | 41 | Each main ~wirecell.<module>~ exposes most of its functionality via a |
|
0 commit comments