Skip to content

Commit

Permalink
Merge pull request #154 from ax3l/doc-changelog101
Browse files Browse the repository at this point in the history
Changelog: 1.0.1
  • Loading branch information
RemiLehe authored Dec 1, 2017
2 parents 5c92cd3 + 5dfd5de commit 9fbc160
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Changelog for the openPMD Standard
==================================

1.0.1
-----
**Date:** 2017-12-01

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

- **backwards compatible changes:**
- better examples for `axisLabels` #153
- unspecified (user-chosen) `float`/`uint`/`int` are now called `floatX`/`uintX`/`intX` throughout the standard #152
- note to store non-openPMD information outside the `basePath` #115
- particle position: update python example #119 #127
- particle patches: typo in reference to `positionOffset` #135

### Extension

- `ED-PIC`:
- **backwards compatible changes:**
- `fieldSmoothing`: typo in allowed values #131
- `fieldSolver`: typo in PSATD description #133
- reference updated to unspecified (user-chosen) `float`/`uint`/`int` as in base standard #152

### Data Converter

No data conversion needed.
4 changes: 2 additions & 2 deletions STANDARD.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The openPMD Standard
====================

VERSION: **1.0.0** (November 11th, 2015)
VERSION: **1.0.1** (December 1st, 2017)

Conventions Throughout these Documents
--------------------------------------
Expand Down Expand Up @@ -75,7 +75,7 @@ Each file's *root* directory (path `/`) must at leat contain the attributes:
- description: (targeted) version of the format in "MAJOR.MINOR.REVISION",
see section "The versions of this standard",
minor and revision must not be neglected
- example: `1.0.0`
- example: `1.0.1`

- `openPMDextension`
- type: *(uint32)*
Expand Down

0 comments on commit 9fbc160

Please sign in to comment.