Skip to content

Commit c87c2f1

Browse files
committed
Rename bin and cleanup Readme
1 parent 17eea60 commit c87c2f1

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -82,44 +82,46 @@ pip install -e .
8282
- Test the CLI tool
8383

8484
```bash
85-
precice-gen --help
85+
precice-case-generate --help
8686
```
8787

8888
## Usage
8989

9090
### Command-Line Interface
9191

92-
Generate a preCICE configuration file from a YAML topology:
92+
Generate a preCICE configuration file from a YAML topology called `topology.yaml`:
9393

9494
```bash
95-
precice-gen -f path/to/your/topology.yaml
95+
precice-case-generate
9696
```
9797

98-
The `precice-gen` tool supports the following optional parameters:
98+
or pass a topology file via argument;
99+
100+
```bash
101+
precice-case-generate -f path/to/your/topology.yaml
102+
```
103+
104+
The `precice-case-generate` tool supports the following optional parameters:
99105

100106
- `-f, --input-file`: Path to the input topology.yaml file.
101-
- **Default**: `examples/1/topology.yaml`
102-
- **Optional**: Yes
107+
- **Default**: `./topology.yaml`
103108
- **Description**: Specify a custom topology file for configuration generation.
104109

105110
- `-o, --output-path`: Destination path for the generated folder.
106-
- **Default**: Current script's parent directory
107-
- **Optional**: Yes
111+
- **Default**: `./_generated/`
108112
- **Description**: Choose a specific output location for generated files.
109113

110114
- `-v, --verbose`: Enable verbose logging.
111115
- **Default**: Disabled
112-
- **Optional**: Yes
113116
- **Description**: Provides detailed logging information during execution.
114117

115118
- `--validate-topology`: Validate the input topology.yaml against the preCICE topology schema.
116119
- **Default**: Enabled
117-
- **Optional**: Yes
118120
- **Description**: Ensures the topology file meets the required schema specifications.
119121

120122
Example usage:
121123
```bash
122-
precice-gen -f custom_topology.yaml -o /path/to/output -v
124+
precice-case-generate -f custom_topology.yaml -o /path/to/output -v
123125
```
124126

125127
> [!NOTE]

0 commit comments

Comments
 (0)