# mesh-academic v3.2.3

**Mercurial revision 5786:5c8b45563631 | 2026-08-04**

---

## Description

`mesh-academic` is a tool designed to **build specific grids** that cannot be created using standard procedures. It is part of the **T-UGOm** (Unstructured Ocean Grid initiative) tools, developed primarily by **LEGOS/CNRS** and the **Bedford Institute of Oceanography**.

> **⚠️ Warning:** Each configuration is **hardcoded** in the source code. Users must **reactivate or create their own configurations** and **recompile** the tool to suit their needs.

---

## Usage

```bash
mesh-academic [OPTIONS] file
```

---

## Options

### **Active Options**


| Option         | Description                                                                                            |
| -------------- | ------------------------------------------------------------------------------------------------------ |
| `-h`, `--help` | Display this help message and exit.                                                                    |
| `--debug`      | Enable debug mode for detailed output.                                                                 |
| `-c <file>`    | Criteria file for mesh building. Defines parameters like mesh resolution, size constraints, etc.       |
| `-n <file>`    | Notebook file for mesh building. Contains predefined grid configurations (e.g., projections, domains). |


---

### **Deprecated Options**

> **Note:** These options are **no longer actively supported** and may not work as expected. They are retained for backward compatibility but should be avoided in new projects.


| Option      | Description                                       |
| ----------- | ------------------------------------------------- |
| `-b <file>` | Bathymetry file (deprecated).                     |
| `-m <file>` | Mesh file (deprecated).                           |
| `-d <file>` | Descriptor file (deprecated).                     |
| `-f <file>` | Boundary file (`.bel` format, deprecated).        |
| `-p <file>` | Polygon file to define the boundary (deprecated). |
| `-z <zone>` | Pre-set zone to define the boundary (deprecated). |
| `-o <file>` | Output file (deprecated).                         |
| `-s <size>` | Mesh size (deprecated).                           |


---

## Examples

### **Basic Usage with Criteria File**

Build a mesh using a predefined criteria file:

```bash
mesh-academic -c criteria.cfg mesh_output.nc
```

### **Using a Notebook File**

Load a predefined grid configuration from a notebook file:

```bash
mesh-academic -n notebook.nbk -c criteria.cfg mesh_output.nc
```

### **Debug Mode**

Enable debug mode to troubleshoot mesh generation:

```bash
mesh-academic --debug -c criteria.cfg mesh_output.nc
```

### **Combining Options**

Combine criteria and notebook files for a custom mesh:

```bash
mesh-academic -c criteria.cfg -n notebook.nbk mesh_output.nc
```

---

## Environment Variables

`mesh-academic` does not rely on specific environment variables. However, it is part of the **T-UGOm** toolchain, which may use standard system environment variables for:

- **Parallel processing** (e.g., `OMP_NUM_THREADS` for OpenMP).
- **File paths** (e.g., `PATH` for locating executables).

---

## Notes

1. **Hardcoded Configurations**:
  - All mesh configurations (e.g., `fe_create_COMODO`, `fe_create_GEOVIDE`, `fe_create_WaveCanal`) are **hardcoded** in the source code.
  - Users must **modify the source code** to customize or add new configurations.
2. **Compilation Required**:
  - After modifying the code or configurations, **recompile** the tool to apply changes.
3. **Deprecated Options**:
  - Avoid using deprecated options (`-b`, `-m`, `-d`, etc.) as they may not function correctly or may be removed in future versions.
4. **Input File**:
  - The `file` argument in the usage command is **mandatory** and typically refers to an input file (e.g., a grid or configuration file).
5. **Output**:
  - Output files (e.g., mesh files) are generated based on the provided configurations. Ensure the output directory is writable.

---

## See Also

- [T-UGOm Initiative](https://www.t-ugom.org/) (Unstructured Ocean Grid initiative)
- [LEGOS/CNRS](https://www.legos.obs-mip.fr/) (Laboratoire d'Études en Géophysique et Océanographie Spatiales)
- [Bedford Institute of Oceanography](https://www.dfo-mpo.gc.ca/science/bedford-institute-oceanography/index-eng.html)
- [SIROCCO National Service](https://www.sirocco.ocean-ops.org/) (INSU/CNRS)