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

Changelog: 1.1.0 #178

Merged
merged 2 commits into from
Feb 6, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,42 @@
Changelog for the openPMD Standard
==================================

1.1.0
-----
**Date:** 2018-02-06

Base paths for mesh- and particle-only files and updated attributes.

This release defines how to handle files that only contain mesh or particle
records gracefully. New attributes have been defined to document software
dependencies and utilized hardware. The ED-PIC extension updated values for
particle pushers. It further improves wordings for consistency throughout the
standard.

## Changes to "1.0.1"

### Base Standard

- **minor changes:**
- `meshesPath` & `particlesPath`: optional (only when needed) #171
- optional attributes to document software dependencies & hardware #170
- `softwareDependencies`
- `machine`
- **backwards compatible changes:**
- fix wording: `meshName` means `mesh record` #168
- fix wording: root path is a "group" as well #169

### Extension

- `ED-PIC`:
- **minor changes:**
- `particlePush`: additional values defined #172

### Data Converter

No data conversion needed.


1.0.1
-----
**Date:** 2017-12-01
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Contributing to the openPMD standard
======================================

The openPMD standard can evolve in order to accommodate the needs of the community. This results in successive [*versions* of the standard](https://github.com/openPMD/openPMD-standard/blob/1.0.1/STANDARD.md#the-versions-of-this-standard). This document explains the process by which the standard evolves, and how to contribute to it.
The openPMD standard can evolve in order to accommodate the needs of the community. This results in successive [*versions* of the standard](https://github.com/openPMD/openPMD-standard/blob/1.1.0/STANDARD.md#the-versions-of-this-standard). This document explains the process by which the standard evolves, and how to contribute to it.

Update Cycle
------------
Expand Down
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.1** (December 1st, 2017)
VERSION: **1.1.0** (Feburary 6th, 2018)

Conventions Throughout these Documents
--------------------------------------
Expand Down Expand Up @@ -75,7 +75,7 @@ Each file's *root* group (path `/`) must at least 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.1`
- example: `1.1.0`

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