imas2xarray

Imas2xarray is a python library for reading and writing IMAS data in hdf5 format using xarray

https://github.com/duqtools/imas2xarray

Science Score: 67.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
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary

Keywords

fusion-data hdf5 imas python xarray
Last synced: 6 months ago · JSON representation ·

Repository

Imas2xarray is a python library for reading and writing IMAS data in hdf5 format using xarray

Basic Info
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 1
  • Releases: 4
Topics
fusion-data hdf5 imas python xarray
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Documentation Status Tests PyPI - Python Version PyPI Coverage DOI

imas2xarray banner

imas2xarray

Imas2xarray is a library that makes it as simple and intuitive as possible to read and write IMAS data in HDF5 format with Python. There is no need to manually define the paths or fiddle with the different dimensions and long keys.

Reading

```python

from imas2xarray import to_xarray

path = '/pfs/work/g2aho/public/imasdb/test/3/92436/1/' ids = 'equilibrium'

ds = toxarray(path, ids) ds Dimensions: (time: 1, rhotornorm: 101, ion: 4) Coordinates: * time (time) float64 50.04 * rhotornorm (rhotornorm) float64 0.0 0.01 0.02 0.03 ... 0.98 0.99 1.0 Dimensions without coordinates: ion Data variables: (12/14) q (time, rhotornorm) float64 0.7887 0.7888 ... 4.262 4.845 collisionality (time, rhotornorm) float64 23.23 7.554 ... 7.31 10.19 tiave (time, rhotornorm) float64 1.036e+04 1.036e+04 ... 508.4 ... ... ne (time, rhotornorm) float64 7.976e+19 ... 1.742e+19 pi (time, ion, rhotornorm) float64 1.242e+05 ... 0.2948 netot (time, rhotor_norm) float64 7.976e+19 ... 1.742e+19 ```

Writing

```python

from imas2xarray import to_imas

ds['t_e'] *= 1.1

to_imas( path, dataset=ds, ids=ids ) ```

For more advanced use-cases and examples, please see the documentation.

Installing imas2xarray

To install:

console pip install imas2xarray

Imas2xarray is supported on Python versions 3.9 or newer.

Development

Check out our Contributing Guidelines to get started with development.

Suggestions, improvements, and edits are most welcome.

Owner

  • Name: duqtools
  • Login: duqtools
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: imas2xarray
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Stef
    family-names: Smeets
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0002-5413-9038'
  - given-names: Victor
    family-names: Azizi
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0003-3535-8320'
repository-code: 'https://github.com/duqtools/imas2xarray'
url: 'https://imas2xarray.readthedocs.io'
abstract: >
  imas2xarray is a tool reading IMAS data in hdf5 format into xarray
keywords:
  - python
  - modelling
  - tokamak
  - uncertainty-quantification
  - fusion-reactor
license: Apache-2.0
version: 0.4.0

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 68
  • Total Committers: 3
  • Avg Commits per committer: 22.667
  • Development Distribution Score (DDS): 0.162
Past Year
  • Commits: 68
  • Committers: 3
  • Avg Commits per committer: 22.667
  • Development Distribution Score (DDS): 0.162
Top Committers
Name Email Commits
Stef Smeets s****s@e****l 57
Stef Smeets s****s 6
Github Action (publish.yaml) v****r@l****u 5
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 11
  • Total pull requests: 10
  • Average time to close issues: 13 days
  • Average time to close pull requests: about 14 hours
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.82
  • Average comments per pull request: 0.0
  • Merged pull requests: 10
  • 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
Top Authors
Issue Authors
  • stefsmeets (6)
  • v1kko (3)
Pull Request Authors
  • stefsmeets (11)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 152 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
pypi.org: imas2xarray

Imas2xarray is a tool reading IMAS data in hdf5 format into xarray.

  • Versions: 4
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 152 Last month
Rankings
Dependent packages count: 10.2%
Downloads: 13.3%
Average: 30.2%
Dependent repos count: 67.1%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/code-style.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/publish.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/test.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • schneegans/dynamic-badges-action v1.7.0 composite
pyproject.toml pypi
  • h5py *
  • importlib_resources python_version<'3.10'
  • numpy *
  • pydantic >= 2.0
  • pydantic-yaml >= 1.0
  • scipy *
  • xarray *
requirements.txt pypi
  • h5py *
  • importlib_resources *
  • numpy *
  • pydantic >=2.0
  • pydantic-yaml >=1.0
  • scipy *
  • xarray *
requirements_full.txt pypi
  • annotated-types ==0.6.0
  • h5py ==3.10.0
  • importlib-metadata ==7.0.0
  • numpy ==1.26.2
  • packaging ==23.2
  • pandas ==2.1.3
  • pydantic ==2.5.2
  • pydantic-core ==2.14.5
  • pydantic-yaml ==1.2.0
  • python-dateutil ==2.8.2
  • pytz ==2023.3.post1
  • ruamel-yaml ==0.17.40
  • ruamel-yaml-clib ==0.2.8
  • scipy ==1.11.4
  • six ==1.16.0
  • typing-extensions ==4.8.0
  • tzdata ==2023.3
  • xarray ==2023.11.0
  • zipp ==3.17.0