Skip to content

manjavacas/melkit

Repository files navigation

logo

Release License Contributors Documentation Status DOI

MELKIT is a multi-purpose Python toolkit designed to easily edit and query MELCOR 1.8.6 files.

⚙️ Utilities

  • CV, CF and FL search, reading and listing.
  • Object creation and removal from a given input file.
  • Object update.
  • EDF variables/values extraction, including dataframe conversion.
  • Query FL connected CVs and CFs.
  • CV extraction by group identifier.
  • Listing of used/available IDs (and export to external .csv).
  • Comment removal.
  • Obtaining duplicate IDs
  • ...

▶️ 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

See our contributing guidelines.