Data

Tools

Indexes

Applications

Experiments

Open Source Science

dagmc-h5m-file-inspector

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

https://github.com/fusion-energy/dagmc_h5m_file_inspector

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary

Keywords from Contributors

neutron stl h5m cad section h5 cross serpent mcnp fispact
Last synced: 7 months ago · JSON representation ·

Repository

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

Basic Info
  • Host: GitHub
  • Owner: fusion-energy
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 56.6 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 4
  • Releases: 1
Created over 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

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)

Create a new conda environment and activate it bash conda create --name new_env python=3.9 conda activate new_env

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

bash conda install -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.

Create a new conda environment and activate it bash conda create --name new_env python=3.9 conda activate new_env Then install Moab and dagmc-h5m-file-inspector ```bash conda install -c conda-forge moab

pip install dagmc-h5m-file-inspector ```

Python API Usage

Finding the volume IDs in a DAGMC h5m file.

```python import dagmch5mfile_inspector as di

di.getvolumesfrom_h5m("dagmc.h5m")

[1, 2] ```

Finding the material tags in a DAGMC h5m file.

```python import dagmch5mfile_inspector as di

di.getmaterialsfrom_h5m("dagmc.h5m")

['steel', 'graveyard'] ```

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

```python import dagmch5mfile_inspector as di

di.getvolumesandmaterialsfrom_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

```bash 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

```bash 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

```bash 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

Owner

  • Name: Fusion Energy
  • Login: fusion-energy
  • Kind: organization

A collection of software projects related to fusion energy

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Shimwell"
  given-names: "Jonathan"
  orcid: "https://orcid.org/0000-0001-6909-0946"
- family-names: "Wilson"
  given-names: "Paul"
  orcid: "https://orcid.org/0000-0002-8555-4410"
title: "dagmc-h5m-file-inspector. Extracts information from DAGMC h5m files including volumes number, material tags"
version: 0.3.0
date-released: 2021-9-13
url: "https://github.com/fusion-energy/dagmc_h5m_file_inspector"

GitHub Events

Total
Last Year

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 52
  • Total Committers: 5
  • Avg Commits per committer: 10.4
  • Development Distribution Score (DDS): 0.212
Top Committers
Name Email Commits
Jonathan Shimwell m****l@j****m 41
autopep8 a****8@u****m 8
Name p****n@w****u 1
shimwell s****l@u****m 1
Jonathan Shimwell d****l@g****m 1
Committer Domains (Top 20 + Academic)
wisc.edu: 1 jshimwell.com: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 2
  • Total pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.08
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • shimwell (1)
  • akoen (1)
Pull Request Authors
  • shimwell (24)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 158 last-month
  • Total dependent packages: 5
  • Total dependent repositories: 1
  • Total versions: 9
  • Total maintainers: 1
pypi.org: dagmc-h5m-file-inspector

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

  • Versions: 9
  • Dependent Packages: 5
  • Dependent Repositories: 1
  • Downloads: 158 Last month
Rankings
Dependent packages count: 1.6%
Average: 20.4%
Dependent repos count: 21.5%
Forks count: 22.6%
Downloads: 24.3%
Stargazers count: 31.9%
Maintainers (1)
shimwell
Last synced: 7 months ago

Dependencies

.github/workflows/anaconda-publish.yml actions
  • actions/checkout v2 composite
.github/workflows/black.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • stefanzweifel/git-auto-commit-action v4 composite
.github/workflows/ci_with_install.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
setup.py pypi