Metadata-Version: 2.4
Name: precice-cli
Version: 1.0.0
Summary: A unified command line interface for preCICE tools.
Author-email: The preCICE Developers <info@precice.org>
Maintainer-email: Frédéric Simonis <frederic.simonis@ipvs.uni-stuttgart.de>
License-Expression: MIT
Project-URL: Homepage, https://precice.org
Project-URL: Repository, https://github.com/precice/config-format.git
Project-URL: Bug Tracker, https://github.com/precice/config-format/issues
Keywords: preCICE,XML,configuration,format,visualization
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: precice-config-visualizer>=2
Requires-Dist: precice-config-format>=2
Requires-Dist: precice-profiling
Requires-Dist: precice-config-check
Requires-Dist: precice-case-generate
Dynamic: license-file

# preCICE CLI

The `precice-cli` is a uniform and simple access to all command line tools of preCICE.
Some commands use tools provided by the preCICE library and require it to be installed.
The installed executables must be in PATH.

## Installation options

Install directly from PyPi using [pipx](https://pipx.pypa.io/stable/) or via pip:

```console
pipx install precice-cli
```

## Usage examples


### Configuration

```console
precice-cli config format precice-config.xml
```

```console
precice-cli config visualize precice-config.xml -o graph.pdf
```

```console
precice-cli config check precice-config.xml
precice-cli config check precice-config.xml SolverOne
```

### Profiling

Pre-processing:

```console
precice-cli profiling merge
```

Post-processing:

```console
precice-cli profiling export
precice-cli profiling trace
precice-cli profiling analyze SolverOne
```

### Version display

```console
precice-cli version
```

### Case generation

```console
precice-cli init
```
