manjavacas / melkit

A MELCOR file manipulation toolkit.

A multi-purpose Python toolkit designed to easily edit and query MELCOR 1.8.6 files.

⚙️ Utilities

• Control Volumes (CVs), Flow Paths (FLs) and Control Functions (CFs) querying and modification.
• PTF and EDF visualization tools.
• Extraction of CVs and FL connections for a given CV.
• Extraction of CFs associated with a given FL, including recursive extraction of inter-dependent CFs.
• Auxiliary tools (comments deletion, duplicates checking...).
• And more!

▶️ Installation

Install MELKIT via PyPI:

pip install melkit

💻 How to use

The Toolkit class is all you need to start working with MELKIT.

from melkit.toolkit import Toolkit

toolkit = Toolkit('file.inp')

cvs = toolkit.read_cvs()
fls = toolkit.read_fls()

Check out the project documentation for additional usage examples.

📦 Extensions

The MELCOR Language Support (MLS) is a MELCOR 1.8.6 syntax highlighter for Visual Studio Code.

It is publicly available at VS Marketplace. Just search for MLS or download it from here.

👐 Contributing

Feel free to contribute via issues and pull requests. See CONTRIBUTING.

📃 License

See LICENSE.