Metadata-Version: 2.4
Name: mpiemses3d-tools
Version: 4.17.0
Summary: CLI utilities for MPIEMSES3D plasma simulations
Author: Jin Nakazono
License: MIT
Project-URL: Homepage, https://github.com/CS12-Laboratory/MPIEMSES3D
Keywords: plasma,PIC,EMSES,simulation,tools
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema>=4.18
Requires-Dist: scipy
Requires-Dist: typer>=0.9
Dynamic: license-file

# mpiemses3d-tools

CLI utilities for [MPIEMSES3D](https://github.com/Nkzono99/mpiemses3d) plasma simulations.

## Installation

```bash
pip install mpiemses3d-tools
```

## Commands

| Command | Description |
|---------|-------------|
| `inp2toml` | Convert Fortran namelist (`plasma.inp`) to TOML format |
| `toml2inp` | Convert `plasma.toml` back to legacy Fortran namelist format |
| `emu` / `emses-unit` | Unit conversion, TOML/input linting, and parameter reference lookup |
| `toml-upgrade` | Upgrade `plasma.toml` from format v1 to v2 |
| `emses-cp` / `cpem` | Copy the mpiemses3D binary as `mpiemses3D`, auto-selecting `mpiemses3D-<env>` on KUDPC |
| `mpiemses3d-build` | Build and install an environment-specific `mpiemses3D-<env>` command |
| `mpiemses-codex-plugin` | Compatibility helper for Codex marketplace registration; use `codex plugin marketplace add/upgrade` in user docs |
| `mpiemses-claude-plugin` | Compatibility helper for Claude Code marketplace registration; use `claude plugin marketplace add/update` in user docs |

Parameter reference lookup examples:

```bash
emu lint plasma.toml
emu lint plasma.inp --format inp --mpi-size 64
emu describe esorem
emu describe emflag
emu describe species --language en
```

## Agent Plugins

### Codex Installation

Register the Codex marketplace directly with the Codex CLI:

```bash
codex plugin marketplace add CS12-Laboratory/MPIEMSES3D \
  --ref main \
  --sparse .agents/plugins \
  --sparse plugins/mpiemses3d-context
codex
# Open /plugins, install "MPIEMSES3D Context", then restart Codex.
```

### Codex Update

Update the registered marketplace with:

```bash
codex plugin marketplace upgrade mpiemses3d
```

### Claude Code Installation

Register the Claude Code marketplace and install the plugin with:

```bash
claude plugin marketplace add CS12-Laboratory/MPIEMSES3D@main \
  --scope user \
  --sparse .claude-plugin plugins/mpiemses3d-context
claude plugin install mpiemses3d-context@mpiemses3d --scope user
# Run /reload-plugins inside Claude Code or restart Claude Code.
```

### Claude Code Update

Update the registered marketplace with:

```bash
claude plugin marketplace update mpiemses3d
```

## Python API

```python
from mpiemses3d_tools.plasma_toml import PlasmaToml
from mpiemses3d_tools.unit_system import UnitSystem
from mpiemses3d_tools.inp2toml import inp2toml
```
