Release: 1.0.1 #156
Merged
Release: 1.0.1 #156
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Close #115: Allow user to store non-openPMD information
code checked with openPMD example data
Particle Position Reading: Fix Python Example
Second change for the example how to combine `position` and `positionOffset` to make it more general. The functions provided now are corrected in namings and usable for general `record components` even outside of the `particle` scope. I still did not add doc strings since I try not to blow up the example since it is already pretty large. The `allocate` option is quite of a fancy thing in case one wants to transparently allocate an ndarray to access it via `[]` later on but could be removed.
But again, allocating a `numpy.ndarray` can be as simple
as doing:
```python
data = record_component.attrs["value"] * \
numpy.ones(shape=record_component.attrs["shape"],
dtype=record_component.attrs["value"].dtype)
```
on a **constant** `record component` so it looks *exactly* as if
one *would* have read a non-constant `record component`.
Refactor Python position Example
Fixes the reference for allowed values in `fieldSmoothing` (same as in current). Discovered copy-paste typo by @Flamefire, thanks!
Fix a copy & paste error in the pseudo-spectral *analytical* time-domain (PSATD) algorithm description.
Corrects as small typo in the base standard and the ED-PIC extension when referring to the particles' `positionOffset`.
Particle Patches: Typo in Reference to positionOffset
ED-PIC: Fix PSATD Long Name
Typo: Allowed Values for `fieldSmoothing`
Fix order of scalar record name
This is a wording change of the openPMD 1.0.0 standard. Description Adds more detailed examples on the `dataOrder` in `axisLabels` attributes for C- and Fortran-style readers and writers. Affected Components - `base` Logic Changes No changes introduced. Writer Changes No data writers affected. Reader Changes No data readers affected. Data Converter No data conversion needed.
Better Examples for axisLabels
This is a rewording change of the openPMD 1.0.0 standard. Description When we are referring to floating point numbers with unspecified (user-chosen) precision, we use `(floatX)` for `(float16|32|64|128|...)` now to avoid confusion with single precision "C" floats. Logic Changes No changes introduced. Writer Changes No data writers affected. Reader Changes No data readers affected.
and adds examples. including the same for uintX and intX
rewrites the usage for double with float64 for consistency.
Unspecified float/int append X
Adds the changelog of the 1.0.1 release.
Increase the version to 1.0.1.
Changelog: 1.0.1
ax3l
added
the
revision change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is release 1.0.1 of the openPMD standard.
Typo and wording changes since the 1.0.0 release.
This release improves wordings, common questions and example snippets.
Keywords and logic are unchanged and backwards compatible for revision releases.
Changes to "1.0.0"
Base Standard
axisLabelsBetter Examples for axisLabels #153float/uint/intare now calledfloatX/uintX/intXthroughout the standard Unspecified float/int append X #152basePathAllow user to store non-openPMD information #115positionOffsetParticle Patches: Typo in Reference to positionOffset #135Extension
ED-PIC:fieldSmoothing: typo in allowed values Typo: Allowed Values forfieldSmoothing#131fieldSolver: typo in PSATD description ED-PIC: Fix PSATD Long Name #133float/uint/intas in base standard Unspecified float/int append X #152Data Converter
No data conversion needed.