Updating the license and readme

LICENSE.txt

@@ -0,0 +1,165 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,99 +1,24 @@
 # IMASPy
 
 IMASPy is a 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.
+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
+## Install
 
-This package is developed on [ITER bitbucket](https://git.iter.org/projects/IMAS/repos/imaspy).
-For user support, contact the IMAS team on the [IMAS user slack](https://imasusers.slack.com),
-open a [JIRA issue](https://jira.iter.org/projects/IMAS), or email the
-support team on <imas-support@iter.org>.
+Install steps are described in the documentation generated from `/docs/source/installing.rst`.
 
-## Installation
-
-### On ITER system, EuroFusion gateway
-
-There is a `module` available on ITER and the Gateway, so you can run
-
-```bash
-module load IMASPy
-```
-
-IMASPy can work with either Access Layer versions 4 or 5 (the used version is
-automatically detected when importing the `imaspy` module). IMASPy still works (with
-limited functionality) when no IMAS module is loaded.
-
-### Local
-
-We recommend using a `venv`:
-
-```bash
-python3 -m venv ./venv
-. venv/bin/activate
-```
-
-Then clone this repository, and run `pip install`:
-
-```bash
-git clone ssh://git@git.iter.org/imas/imaspy.git
-cd imaspy
-pip install .
-# Optional: also install `imas-core` with the HDF5 backend in the venv:
-pip install .[imas-core]
-```
-
-If you get strange errors you might want to upgrade your `setuptools` and `pip`.
-(you might want to add the `--user` flag to your pip installs when not in a `venv`)
-
-### Development installation
-
-For development an installation in editable mode may be more convenient, and
-you will need some extra dependencies to run the test suite and build
-documentation.
-
-```bash
-pip install -e .[test,docs]
-```
+Documentation is autogenerated from the source using [Sphinx](http://sphinx-doc.org/)
+and can be found at the [ITER sharepoint](https://sharepoint.iter.org/departments/POP/CM/IMDesign/Code%20Documentation/IMASPy-doc/index.html)
 
-Test your installation by trying
+The documentation can be manually generated by installing sphinx and running:
 
 ```bash
-cd ~
-python -c "import imaspy; print(imaspy.__version__)"
+make -C docs html
 ```
 
-which should return your just installed version number.
-
-### Installation without ITER access
-
-The installation script tries to access the [ITER IMAS Core Data Dictionary repository](https://git.iter.org/projects/IMAS/repos/data-dictionary/browse)
-to fetch the latest versions. If you do not have git+ssh access there, you can
-try to find this repository elsewhere, and do a `git fetch --tags`.
-
-Alternatively you could try to obtain an `IDSDef.zip` and place it in `~/.config/imaspy/`.
-
-Test your installation by trying
-
-```bash
-python -c "import imaspy; factory = imaspy.IDSFactory()"
-```
-If the following error is raised:
-```bash
-RuntimeError: Could not find any data dictionary definitions. 
-```
-it means that the Data Dictionary definitions weren't created during the install.
-You can generate these definitions by executing `build_DD` in the command line.
-Missing packages can include among others: [GitPython](https://github.com/gitpython-developers/GitPython), and Java.
 
 ## How to use
 
@@ -106,32 +31,20 @@ print(equilibrium)
 equilibrium.ids_properties.homogeneous_time = imaspy.ids_defs.IDS_TIME_MODE_HETEROGENEOUS
 equilibrium.ids_properties.comment = "testing"
 
-dbentry = imaspy.DBEntry(imaspy.ids_defs.HDF5_BACKEND, "ITER", 1, 1)
-dbentry.create()
-dbentry.put(equilibrium)
-
-# TODO: find an example with a significant change between versions (rename?)
-older_dbentry = imaspy.DBEntry(imaspy.ids_defs.HDF5_BACKEND, "ITER", 1, 1, version="3.35.0")
-equilibrium2 = older_root.get("equilibrium")
-print(equilibrium2.ids_properties.comment)
+with imaspy.DBEntry("imas:hdf5?path=./testdb","w") as dbentry:
+    dbentry.put(equilibrium)
 ```
 
-## Documentation
-
-Documentation is autogenerated from the source using [Sphinx](http://sphinx-doc.org/)
-and can be found at the [ITER sharepoint](https://sharepoint.iter.org/departments/POP/CM/IMDesign/Code%20Documentation/IMASPy-doc/index.html)
+A quick 5 minutes introduction is available in the documentation generated from `/docs/sources/intro.rst`.
 
-The documentation can be manually generated by installing sphinx and running:
 
-```bash
-make -C docs html
-```
+## Legal
 
-## Interacting with IMAS AL
+IMASPy is Copyright 2020-2024 ITER Organization, Copyright 2020-2023 Karel Lucas van de 
+Plassche <karelvandeplassche@gmail.com>, Copyright 2020-2022 Daan van Vugt <dvanvugt@ignitioncomputing.com>,
+and Copyright 2020 Dutch Institute for Fundamental Energy Research <info@differ.nl>.
+It is licensed under [LGPL 3.0](LICENSE.txt).
 
-Interaction with the IMAS AL is provided by a Cython interface to the Access Layer.
-As Cython code, it needs to be compiled on your local system.
-To find the headers, the Access Layer `include` folder needs to be in your `INCLUDE_PATH`. On most HPC systems, a `module load IMAS` is enough.
 
 ## Acknowledgments