Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/1.2.0 #8

Closed
wants to merge 37 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
a5acf1e
Implement `DBEntry.get_sample` in IMASPy
maarten-ic Jul 9, 2024
fd49e02
Add docstrings for GetSliceParameters / GetSampleParameters
maarten-ic Jul 9, 2024
45aaaaa
Merge remote-tracking branch 'origin/develop' into feature/IMAS-3885-…
maarten-ic Nov 11, 2024
73268bb
Update tests for DD 4.0.0
maarten-ic Nov 11, 2024
bc9ea19
Update NCDBEntryImpl for get_sample and raise NotImplementedError
maarten-ic Nov 11, 2024
674460b
Set `begin_timerange_action` as available since AL core 5.4
maarten-ic Nov 11, 2024
0a47f94
Make the NC2IDS reader class-based
maarten-ic Nov 14, 2024
d59fcab
Add missing docstring
maarten-ic Nov 14, 2024
4d028e2
Merge remote-tracking branch 'origin/develop' into feature/IMAS-3885-…
maarten-ic Nov 15, 2024
ee385b7
Disable MDSplus backend tests for get_sample
maarten-ic Nov 15, 2024
d518a87
Pull request #239: Make the NC2IDS reader class-based
maarten-ic Nov 15, 2024
b007316
Add validation for the ids_properties.homogeneous time variable in ne…
maarten-ic Nov 13, 2024
f7be384
Additional validation checks and tests
maarten-ic Nov 15, 2024
e524646
Fix a bug with lazy loading multiple IDSs from the same HDF5 DBEntry
maarten-ic Nov 19, 2024
d47566b
Validate netCDF sparsity metadata
maarten-ic Nov 19, 2024
54d78d6
Add environment variable to disable netCDF file validation.
maarten-ic Nov 19, 2024
5ccae5d
Eliminate nc2ids function
maarten-ic Nov 19, 2024
afb8c29
Update `get_sample` docstring to clarify that the interpolation mode …
maarten-ic Nov 20, 2024
983a652
Pull request #241: Fix a bug with lazy loading multiple IDSs from the…
maarten-ic Nov 22, 2024
6cd1e44
Add `validate_nc` command to imaspy CLI
maarten-ic Nov 22, 2024
6ec21c7
Fix incorrect exception when using mode="x" for netCDF files
maarten-ic Nov 25, 2024
1f6c6fe
Close netCDF datasets when an exception is raised
maarten-ic Nov 25, 2024
b7d8963
Add unit tests for `nc_validate.py`
maarten-ic Nov 25, 2024
fc2cbf2
Additional documentation for the `imaspy validate_nc` command line tool
maarten-ic Nov 27, 2024
3c35fa9
Pull request #220: Implement `DBEntry.get_sample` in IMASPy
maarten-ic Dec 3, 2024
7c56b5f
Explicitly set `IDSDEF_PATH` when opening a DBEntry with the UDA backend
maarten-ic Dec 4, 2024
74d2e3a
Make prepare_data_dictionaries compatible with DD>4.0.0 (change in sc…
olivhoenen Dec 9, 2024
77fb044
Updating the license and readme
olivhoenen Dec 11, 2024
d80778f
Replace references to LICENSE.md to LICENSE.txt
maarten-ic Dec 12, 2024
bd098bb
Pull request #244: Add `validate_nc` command to imaspy CLI
maarten-ic Dec 12, 2024
d427972
Pull request #248: Replace references to LICENSE.md to LICENSE.txt
maarten-ic Dec 12, 2024
1968cde
Pull request #246: Make prepare_data_dictionaries compatible with DD>…
olivhoenen Dec 12, 2024
cef4667
Fix a bug with lazy loading
maarten-ic Dec 17, 2024
4beab9f
Add contributing guidelines
olivhoenen Jan 10, 2025
2eb385e
fixed readme.md for imas
gautamraj8044 Dec 13, 2024
133f78c
Apply suggestion on naming
olivhoenen Dec 17, 2024
6f871f5
Update README.md
gautamraj8044 Dec 17, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <imas-administration@iter.org>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing guidelines

We welcome any kind of contribution to `imas-python`,
from a simple comment, a question or even a full fledged pull
request.
Please first make sure you read and follow the
[Code of Conduct](CODE_OF_CONDUCT.md).

## You think you found a bug in the code, or have a question in its use
1. use the [issue search](https://github.com/iterorganization/
imas-python/issues) to check if someone already created
a similar issue;
2. if not, make a **new issue** to describe your problem or question.
In the case of a bug suspiscion, please try to give all the relevant
information to allow reproducing the error or identifying
its root cause (version of the imas-python, OS and relevant
dependencies, snippet of code);
3. apply relevant labels to the issue.

## You want to make or ask some change to the code
1. use the [issue search](https://github.com/iterorganization/
imas-python/issues) to check if someone already proposed
a similar idea/change;
2. if not, create a **new issue** to describe what change you would like to see
implemented and specify it if you intend to work on it yourself or if some help
will be needed;
3. wait until some kind of consensus is reached about your idea being relevant,
at which time the issue will be assigned (to you or someone else who can work on
this topic);
4. if you do the development yourself, fork the repository to your own Github
profile and create your own feature branch off of the latest develop commit.
Make sure to regularly sync your branch with the latest commits from `develop`
(find instructions
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/
working-with-forks/syncing-a-fork);
5. when your development is ready, create a pull request (find instructions
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/
proposing-changes-to-your-work-with-pull-requests/
creating-a-pull-request-from-a-fork)).


While we will try to answer questions quickly and to address issues in a timely
manner, it can may sometimes take longer than expected. A friendly ping in the
discussion or the issue thread can help draw attention if you find that it was
stalled.
46 changes: 0 additions & 46 deletions LICENSE.md

This file was deleted.

165 changes: 165 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -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.
Loading