Skip to content

Configuration documentation: Add a first example and name sections #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IshaanDesai merged 1 commit into from
May 19, 2026
+25 −1
Merged

Configuration documentation: Add a first example and name sections #267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,28 @@ summary: Provide a JSON file to configure the Micro Manager.

{% note %} In the preCICE XML configuration the Micro Manager is a participant with the name `Micro-Manager`. {% endnote %}

The Micro Manager is configured with a JSON file. Several parameters can be set.
The Micro Manager is configured with a [JSON](https://en.wikipedia.org/wiki/JSON#Syntax) file. Several parameters can be set, in different sections. For example:

```json
{
"micro_file_name": "python/micro.py",
"coupling_params": {
"precice_config_file_name": "precice-config.xml",
"macro_mesh_name": "Macro-Mesh",
"read_data_names": ["Macro-Scalar", "Macro-Vector"],
"write_data_names": ["Micro-Scalar", "Micro-Vector"]
},
"simulation_params": {
"micro_dt": 1.0,
"macro_domain_bounds": [0.0, 1.0, 0.0, 1.0, 0.0, 1.0]
}
}
```

## Micro Manager Configuration

These parameters are in the outer section.

| Parameter | Description | Default |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `micro_file_name` | Path to the file containing the Python importable micro simulation class. If the file is not in the working directory, give the relative path from the directory where the Micro Manager is executed. | - |
Expand All @@ -25,6 +43,8 @@ Apart from the base settings, there are three main sections in the configuration

## Coupling Parameters

These parameters are in the section `coupling_params`.

| Parameter | Description |
|----------------------------|--------------------------------------------------------------------------------|
| `precice_config_file_name` | Path to the preCICE XML configuration file from the current working directory. |
Expand All @@ -34,6 +54,8 @@ Apart from the base settings, there are three main sections in the configuration

## Simulation Parameters

These parameters are in the section `simulation_params`.

| Parameter | Description | Default |
| --- | --- | --- |
| `macro_domain_bounds` | Minimum and maximum bounds of the macro-domain, having the format `[xmin, xmax, ymin, ymax, zmin, zmax]` in 3D and `[xmin, xmax, ymin, ymax]` in 2D. | - |
Expand All @@ -50,6 +72,8 @@ Non-uniform domain decomposition is based on a geometric progression.

## Diagnostics

These parameters are in the section `diagnostics`.

| Parameter | Description | Default |
|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `data_from_micro_sims` | Dictionary with the names of the data from the micro simulation to be written to VTK files as keys and `"scalar"` or `"vector"` as values. | - |
Expand Down