Skip to main content

Extracts information from DAGMC h5m files including volumes number, material tags

Project description

N|Python

CI with install

codecov

Upload Python Package PyPI

dagmc-h5m-file-inspector

A minimal Python package that finds the volume ids and the material tags in a DAGMC h5m file.

Installation (Conda)

The dagmc-h5m-file-inspector package can be installed with a single conda install terminal command.

conda install -c fusion-energy -c fusion-energy -c conda-forge dagmc_h5m_file_inspector

Installation (Conda + Pip)

The dagmc-h5m-file-inspector package requires pymoab which can be installed alongside Moab with a conda install command. Moab is not avialable on pip, however it can be installed with Conda.

conda install -c conda-forge moab

pip install dagmc-h5m-file-inspector

Python API Usage

Finding the volume IDs in a DAGMC h5m file.

import dagmc_h5m_file_inspector as di

di.get_volumes_from_h5m("dagmc.h5m")

>>> [1, 2]

Finding the material tags in a DAGMC h5m file.

import dagmc_h5m_file_inspector as di

di.get_materials_from_h5m("dagmc.h5m")

>>> ['steel', 'graveyard']

Finding the volume IDs with their materials present in a DAGMC h5m file.

import dagmc_h5m_file_inspector as di

di.get_volumes_and_materials_from_h5m("dagmc.h5m")

>>> {1: 'steel', 2: 'graveyard'}

Command line tool usage

The options for the command line tool can be obtained with inspect-dagmc-h5m-file --help

Print the volume IDs present in a dagmc h5m file to the terminal

inspect-dagmc-h5m-file -i dagmc.h5m -v
>>> Volume IDs =[1, 2]

Print the material tags present in a dagmc h5m file to the terminal

inspect-dagmc-h5m-file -i dagmc.h5m -m
>>> Material tags =['steel', 'graveyard']

Print the volume IDs and materials present in a dagmc h5m file to the terminal

inspect-dagmc-h5m-file -i dagmc.h5m -b
>>> Volume IDs and material tags=
     {   1: 'steel',
         2: 'graveyard'}

Write the volume IDs and materials present in a dagmc h5m file to a txt file

inspect-dagmc-h5m-file -i dagmc.h5m -b -o output.txt
>>> writing file output.txt

Aknowledgements

This package is based on a Python script by @gonuke

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dagmc_h5m_file_inspector-0.5.0.tar.gz (10.1 kB view hashes)

Uploaded Source

Built Distribution

dagmc_h5m_file_inspector-0.5.0-py3-none-any.whl (6.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page