IMASPy Manual

IMASPy is (yet another) pure-python library to handle arbitrarily nested data structures. IMASPy is designed for, but not necessarily bound to, interacting with Interface Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS) Data Model.

It provides:

  • An easy-to-install and easy-to-get started package by

    • Not requiring an IMAS installation

    • Not strictly requiring matching a Data Dictionary (DD) version

  • An pythonic alternative to the IMAS Python High Level Interface (HLI)

  • Checking of correctness on assign time, instead of database write time

  • Dynamically created in-memory pre-filled data trees from DD XML specifications

For users

  • Documentation is WIP! !4

  • iter_cluster

README

The README is best read on KLIMEX/IMASPy/#imaspy.

For developers

LICENSE

Copyright (c) 2020 Karel Lucas van de Plassche <karelvandeplassche@gmail.com>
Copyright (c) 2020 Dutch Institute for Fundamental Energy Research <info@differ.nl>
Copyright (c) 2020 Daan van Vugt <dvanvugt@ignitioncomputing.com>
Copyright (c) 2020-2021 ITER Organization

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.