Metadata-Version: 2.4
Name: jcmsuite-notebooks
Version: 7.4.2
Summary: Notebook and Matlab converter tooling for JCMsuite workflows.
License-Expression: MIT
Author: Matthias Plock
Author-email: matthias.plock@jcmwave.com
Requires-Python: >=3.13
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: jinja2 (>=3.1,<4.0)
Requires-Dist: notebook (>=7.0.0)
Project-URL: Documentation, https://docs.jcmwave.com/JCMsuite/html/
Project-URL: Homepage, https://www.jcmwave.com
Description-Content-Type: text/markdown

# jcmsuite-notebooks

Standalone notebook and Matlab template tools for JCMsuite workflows.

Use this package to generate notebook or Matlab templates and launch notebooks
with parent-process monitoring. It provides support tools, not the JCMsuite
solver interface or a collection of ready-to-run solver tutorials.

## What It Provides

- notebook template generation helpers,
- Matlab template generation helpers,
- guarded notebook-launch support for parent-process-aware workflows,
- typed exceptions for notebook/converter runtime and configuration errors.

## Primary Python Entry Points

- `generate_legacy_notebook_template(...)`
- `generator_main(...)`
- `launch_notebook_with_parent_monitor(...)`
- `launcher_main(...)`

Python imports use `jcmsuite_notebooks`, for example:

```python
from jcmsuite_notebooks import generate_legacy_notebook_template
```

## Install

Requires Python 3.13 or later. Installation includes Jinja2 and Jupyter Notebook.

```bash
python -m pip install jcmsuite-notebooks
```

## Relationship To `jcmsuite`

Use this package when you specifically need the notebook or Matlab conversion
tooling as a low-level dependency. For solver/runtime workflows, install the
main `jcmsuite` package instead.

Template generation does not install or run the JCMsuite solver. Running generated
code requires the runtime and input files used by that code; JCMsuite solver
operations require a separate JCMsuite installation and license.

## Documentation and Support

See the [JCMsuite documentation](https://docs.jcmwave.com/JCMsuite/html/) for the
JCMsuite manuals and tutorials. For product and support information, visit
[JCMwave](https://www.jcmwave.com).

## License

This Python package is licensed under the MIT License.

