Repository files navigation

IMAS-Python (formerly known as IMASPy its for versions < 2) is a pure-python library to handlearbitrarily nested data structures. It is designed for, but not necessarily bound to, interactingwith Interface Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS)Data Model.

Simply install IMAS-Python withpip:

pip install imas-python

or with optional dependencies for netCDF and xarray support:

pip install imas-python[netcdf,xarray]

More details are described in the documentation generated from/docs/source/installing.rst.The documentation is autogenerated from the source usingSphinxand can be found at thereadthedocs

To generate the documentation yourself, install thedocs optional dependencies and do:

make -C docs html

importimasfactory=imas.IDSFactory()equilibrium=factory.equilibrium()print(equilibrium)equilibrium.ids_properties.homogeneous_time=imas.ids_defs.IDS_TIME_MODE_HOMOGENEOUSequilibrium.ids_properties.comment="testing"equilibrium.time= [0.01]withimas.DBEntry("imas:hdf5?path=./testdb","w")asdbentry:dbentry.put(equilibrium)# or without imas_core dependencywithimas.DBEntry("./test.nc","w")asdbentry:dbentry.put(equilibrium)

A quick 5 minutes introduction is available in the documentation generated from/docs/sources/intro.rst.

IMAS-Python is Copyright 2020-2025 ITER Organization, Copyright 2020-2023 Karel Lucas van dePlasschekarelvandeplassche@gmail.com, Copyright 2020-2022 Daan van Vugtdvanvugt@ignitioncomputing.com,and Copyright 2020 Dutch Institute for Fundamental Energy Researchinfo@differ.nl.It is licensed underLGPL 3.0.

Inspired and bootstrapped by existing tools, notably the IMAS Python HLI,IMAS Python workflows, and OMAS.