Metadata-Version: 2.1
Name: idspy_dictionaries
Version: 34000.2.1
Summary: IMAS Data Dictionaries converted to Python Dataclass used in the IMAS-GK/IDSPy project
Author-email: Guillaume Fuhr <guillaume.fuhr@univ-amu.fr>
License: BSD 3-Clause License
        
        Copyright (c) 2023, CNRS, contributor: Y. Camenen
        Copyright (c) 2023, Aix-Marseille Univ., contributor: G. Fuhr
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://gitlab.com/gkdb/imas-gk
Project-URL: Bug Tracker, https://gitlab.com/gkdb/imas-gk/-/issues
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE

IDSPy_Dictionaries
==================

IMAS Data Dictionaries converted to Python Dataclass used in the  IDSPy suite.

Prerequisites
=============

To use this script, you need to have Python **3.9** or later installed. You can download Python from https://www.python.org/downloads/.
Please note that Python at least **3.10** is recommended.

Installation
============

To install the necessary packages, run the following command:

.. code-block:: console

   python -m pip install idspy_dictionaries

Usage
=====

To load the desired IDS :

.. code-block:: python

   from idspy_dictionaries import ids_gyrokinetics_local # or any other available IDS
   new_ids = ids_gyrokinetics_local.Gyrokinetics()

FAQ
===

**Q:** What is the minimum required version of Python to run this script?
  **A:** The  recommended version of Python is 3.10. It can be used with Python >= 3.9
          but there is no support in that case.

**Q:** Can I add new members to the dataclasses?
  **A:** This option is not possible to be sure that the dataclasses follow the IMAS conventions.

**Q:** Is the package compatible with pydantic and/or attrs?
  **A:** Short answer, no ;)

**Q:** I would really like to use python <3.9 is it really impossible?
  **A:** IDSPy_dictionaries used mainly python dataclasses and the slot property which had been added in python 3.10 only.
         The main reason to use __slots__ is to avoid addition of members in the IDS and remains fully compliant with IMAS.
         A version of the package had been published "as it is" without the slots dependency but need at least python 3.9.
         The way dataclasses are generated with the associated fields, at the opposite, is not compatible at all with python 3.8.


**Q:** Can I load all the dictionaries at once?
  **A:** For performances reasons, it's not possible right now.
