Skip to content

Commit

Permalink
Merge branch 'master' into string
Browse files Browse the repository at this point in the history
  • Loading branch information
JimBiardCics authored Sep 10, 2019
2 parents 8c7d66d + f56f374 commit 3f0e55a
Show file tree
Hide file tree
Showing 26 changed files with 645 additions and 80 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/defect-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Defect issue
about: Use to document inconsistencies or errors
title: ''
labels: defect
assignees: ''

---

Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html

Change proposals should include the following information as applicable.

**Title:** Short and descriptive.
**Moderator:** @user
**Requirement Summary:** A few sentence functional summary
**Technical Proposal Summary:** Brief proposal overview
**Benefits:** Who or what will benefit from this proposal?
**Status Quo:** Discussion of the current state CF and other standards.
**Detailed Proposal:** Complete proposal
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Enhancement issue
about: Use for issues that add new capabilities or improve existing ones
title: ''
labels: enhancement
assignees: ''

---

Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html

Change proposals should include the following information as applicable.

**Title:** Short and descriptive.
**Moderator:** @user
**Moderator Status Review [last updated: YY/MM/DD]:** Brief comment on current status, update periodically
**Requirement Summary:** A few sentence functional summary
**Technical Proposal Summary:** Brief proposal overview
**Benefits:** Who or what will benefit from this proposal?
**Status Quo:** Discussion of the current state CF and other standards.
**Detailed Proposal:** Complete proposal
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/github-usage-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Github usage issue
about: Use to document an issue with how CF uses github
title: ''
labels: GitHubProblem
assignees: ''

---

Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question Issue
about: Use for questions you want help with
title: ''
labels: question
assignees: ''

---

Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/style-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Style Issue
about: Use for issues concerning formatting or document syntax
title: ''
labels: style
assignees: ''

---

Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/typo-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Typo Issue
about: Use for small errors in spelling or grammar
title: ''
labels: typo
assignees: ''

---

Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html
8 changes: 1 addition & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
See http://cf-trac.llnl.gov/trac/ticket/XXX

- [ ] Added link from trac ticket to this PR?

> Applied via ​https://github.com/cf-convention/cf-conventions/pull/XXX
- [ ] Updated "Revision History"? (Use the date you applied the changes.)
See issue #XXX for discussion of these changes.
5 changes: 3 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
language: ruby
rvm:
- 2.1.2
- 2.6

install:
- gem install asciidoctor
Expand Down Expand Up @@ -38,7 +38,7 @@ after_success:
git add $TARGET_DIR/index.html;
fi
- git commit -m "Auto-generated from ${TRAVIS_REPO_SLUG}@${TRAVIS_COMMIT}"
- git push https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages >/dev/null 2>&1
- git push https://${GHT_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages >/dev/null 2>&1

branches:
only:
Expand All @@ -49,6 +49,7 @@ branches:
env:
global:
# Values for cf-conventions-bot/cf-conventions
- secure: "AduHBhrgWc2XOSXUdCzQ8W7z12iHhQjzZgodVbulftW+Uwn2tGx5bPBc0MrrfPJ0AaoE5e1ZeCGk6ZGYVMnOAQEq95NpTJWuqKtfGFvYVuhbVYQ989ZacSugxEWY8zp2yTulQCQ4iuL/HnSgRVEAlAbkIbrjG8mwgBFeXeyUB9TRn11huw/P9PfOOKOVdxgcYmnYzQSD5DVWreLGag6oXMQ/3o3SJUDGpXToZeO+yQZXnKpjEKKIMey0fkCeDeZbviTKVO1A70iiBk9Zc5WEf8FzyJ/sUDr9qjI3gxp70CPV+32aKzqXoxNclssOFPYDoWBZDs8rYS7OBEgyJvE5At5ZhGAmcLn0UGjCSepruJeDdOEYv3tc3QfKm+ZkqNDOjTaHS3gLqHofXqk6C9ppLRzZSxCDbNP7N1nQ/fGMp3dPMrBlH+GG+BNpsQ+wEFY0G9O2veRKfMZnIz5/Lqn20SUOV/0x2FlgYfm1PUBzuqnkwcc+YSOzKNwf4LpCZhUQVQlGWxTmrq9mcSXxi1KzJ7N67+SDqu4x5xC0VI1yrQBGVATCBJYC7XYIe+sABO2gBM9tkO7FpVSzbNDWCnDAPELvBbB1KZfBpV6MI5F9Qx8c2ExnepeOHRIpvcvDJoQfihX8fGXZYbl/XLLnoHmnPJGA8CexMnBHXGHLF6uxdWI="
- secure: "d+R5tzKSdhytTnjrIW3oAqEnoiVY1I/pqcfNQDBrHDNE+FuCuaGCvjrQuRCil50SAMiZ0/80aN8t9I7iwY2hCcUGJoyfgzTjPi/x0RytcQR4q5qylJw33L3Va1r7g91Y7Fi78c5rXLqXZf/wqhiyTw4uLfMum0ka8TLGn0U960mD9PO8uhavJNZbUsF4puN2q5s7PWBhayVm6S5WiGpKINH3lhH4aFz5+oEBidtBRHMZtT4w5hmjXpU0nd6CfF9/+reMmTjJnbNGCbtTRN3UodIU2OY7ToeLD73f7aBoIOVS2LSjtyWZzCvWszcH7y2U2HlmIiyUA2/DMAnYKYuxHa4P0R5xpSZWUSMb517/YVRWDrJVcQaoWdB4hYQsSYo6Nv/Hj35vf1E7sXiwZCPzSaEWRes31E5mf22Ug5+5R1GwTv0FZ2BxdJ+EZThVvWkm2Cvb4yrOObCq+jC2Z1iJ/f9P0q7DNKzgePiv5MsMWzNFfJ5nwRG9cRl5tbghnScKFntf2LSMVtmHUFHYty1TgxgePko4hUOD3IB14zv71dJLu07qdRuyjZYOjM/qwGfW+FaEcuNC1DHKU+eJPGP9GJjaf+iCM/FQiYiepuofp5ys7k4yqLLlW/FCWGNIPZEdKt4ZggHAl9rCmUDMZF5gClr9YjrbYtCl8mOVYKCVPUg="
- secure: "3KygyBd58pedh3zsDMAI8HZY7G5w7Y4ZYDvAERBPoZQmM23XD0Ot8TPUM3RGAVBsAhxwomrVaBJNRaMc9/yr8cvarD+o8G/YfgITNVDsSbXTb6cBkA499bTawDK1ocKDGXUYTwGbaLSV9kLiD/0NXptkFEQFzsNtRwsvUXXHOp+j4UBJutCZKZhD/1OfHxk23JmKhkAgeKcOGJ8F3xv3NPwp5DBJ3z3/l31aVjckft+og0EPARJOFxlLEA3/pKwJpuV4LdvuiWK5slDc+IVMgAmJm+5BlqaluH+zBxMol3/uXL57JX0rNIOTKwXQj6Xy+r1iQMlrazK1qy0Z/xQN5IBGjdu4CaDxhg1Kh0yfkZ+TtnamnjbdXYW1/AJW3kuVDFJAdWdRnuZAI4NIWPJTVDDgDVCnqyzduM2O/q8lqvA2U1eTpTnGcExDJZO3zMCj+/opAj1o00HBdxS7hFhN/phBuARwCz+Vj1hoC6p+jC515X+1mhtuP1ghiGVwrmJTyqY1Xc8xJF6xqqhTKR6SGphgeM8OnHeoJeCBspS1ehJkHm9Z7ENmB+bIV082aw4Ti95v0rdRtUOF4L9UUsPJvq/uwxFVAMYr6nbZM4pd+kko+tQsbUoC6g6N+Zn1vcNFQYDkK1StBESxLQ8SxZXXt+Xbjv1bvT88isyKpXlxAQw="
- secure: "LpRVpYe0hphtelWP5U5o7GMicgorl1TSwmedPG7Sa0TUvqNQltRXXbkGodxtu7fUKrw+SBp+6CGVmgU5RP+Z+R5xETRxNY0IyA8up4uKKACjWvVi5eLp3fKR2R6I0l1LF2GfAtIgV6K2QQWjwar2zrVeN8hs29eI9HqEWQpwgqDxEnHmHpaL84OIcVtNUJkuiIJRkepOHthLe1N3V+xmqYnjXYjmAyN7yyYC+x8KIxqjJSKRUsOmhJwnwpUw27r9QhsVc033KDz+cSm/hG87gnRTkr3iD4jxArKi9d5Oat9ahip6XxLs7MzDpDbb69KTMpf3y4SARuVJ7GW0Gget3GjqF4Ly0r/TLYp4ztWy6aDPvI13w9PJ2NO+L169Vn8HvtRVB45Hu4svFIjpMow80QC10BqUAmKk/AaxSdwQzkZEFPzvYgTGTJjkBy9Gk5isnNoA1GOz2g2b+NZc/H/TuvkvFZBAT4Bl4I1btr9qnYrp5Hinkz+jkUmhGkxD/K0BBa8Cd+bbj+2HyKjAhRTH8g65nIKmgyO97308BBwKeOl2g8kEil6qYydbqLrM9zVJeyYhyTzDFzsXrqWE8g1PT8kO3+5O2FRrZ6otKbCbRUTlkzw/Wzz9leFpOtqYsh59i8sxq1uGVEH3lrbXvfYkBaHnrxXT6FJw5wdcLLu6lW0="
Expand Down
25 changes: 25 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

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. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing to the NetCDF-CF conventions

Dear CF community member,

Thank you for taking the time to consider making a contribution to the [cf-conventions](http://cfconventions.org/).
The NetCDF Climate and Forecasting conventions are a product by and for a broad community and your contribution is the key to their usefulness.

This set of guidelines provides a brief overview of the practices and procedures that should be used in fixing, updating, or adding to the conventions.
It builds on the [rules for CF Convention changes.](http://cfconventions.org/rules.html)

As a prerequisite to this guide, please review the community's code of [conduct.](https://github.com/cf-convention/cf-conventions/blob/master/CODE_OF_CONDUCT.md)
The CF community takes great pride in respectful and collegial discourse. Any disrespectful or otherwise derogatory communication will not be tolerated.

## General Guidelines

1. **A given proposal should be discussed as one issue.** It shouldn't fork or be superseded by another one, unless that reflects what has happened to the proposal.
This is so it is easy to trace the discussion that led to a given agreed proposal.

2. **A proposal should convey the reasoning and effect on all relevant sections of the specification.**
An overview of all actual changes and the impact the changes have on the specification should be clear.
Depending on the length and nature of the proposal, this may require different approaches as described below.

3. **In general, issues should be used for discussion of proposed changes and pull requests should be used for review of agreed upon changes.**
In other words, if the content or concept of what is being proposed needs to be vetted by the community it should be vetted in an issue.
If the proposal is non-controversial (such as a typo correction) or has been agreed to in concept in an issue, then detailed review of the text may take place in a pull request.
Practically all changes should be documented and discussed in an issue fixed in a related pull request.

4. **Use [labels](https://github.com/cf-convention/cf-conventions/labels) on issues and pull requests.**
Currently this is achieved by using an appropriate issue template when creating a [new issue](https://github.com/cf-convention/cf-conventions/issues/new/choose).

## Issues and Pull Requests

Issues should attempt to follow the guidelines here and in the issue template as much as possible.
All new pull requests should be submitted to the master branch and will be merged or closed as soon as agreement has been reached.
Use of other branches is at the discretion of the repository administrators.
The following cases describe potential patterns of use for issues and pull requests.

1. **Typo Fix** If the change is a non-controversial fix such as a typo, no issue is required as these changes do not appear in the convention history.
A pull request with the fix can be submitted directly.
Contributors not familiar with github can submit issues for typos and similar issues for others to fix.

2. **Single Section Change** In the case of a change concerning one to a few paragraphs, an issue should be opened that describes the problem and proposed fix.
If important to the issue, the problem text should be pasted in the body of the issue and proposed fix included.
A link to the line where the problem exists could also be included.
If the modification is non-controversial, a pull request could be opened simultaneously.
Discussion of the proposal should take place in one issue.
Final review should take place in the pull request and the issue closed when the pull request is merged.

3. **Changes Spanning Multiple Sections** If reasonable, changes concerning multiple sections should follow the pattern described in Single Section Change.
If explicitly listing proposed changes is not practical, general guideline 2 should be followed to document the proposal.
Depending on the nature of the proposal, interested community members can decide what the most effective tool is for development and review of specification changes.
Tools used for development of significant changes are up to those contributing and reviewing it.
Note that there is a rendered "rich-diff" view of a pull request that can be helpful for review of large contributions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

### Status

This is an *unofficial* work-in-progress to show how the CF metadata conventions
could be managed via GitHub, Travis-CI, and asciidoctor. The output from this
process can be seen at: http://cfconventions.org/cf-conventions/cf-conventions.html
This repository contains the official source of the CF metadata conventions.
The source files are built into HTML automatically when changes are merged into this repository.
The latest build of the specfication is held in the `gh-pages` branch and can be seen at: http://cfconventions.org/cf-conventions/cf-conventions.html.

For the official web site please visit: http://cfconventions.org/,
and the corresponding GitHub organisation: https://github.com/cf-convention.
Expand Down
55 changes: 48 additions & 7 deletions appa.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

All CF attributes are listed here except for those that are used to describe grid mappings. See Appendix F for the grid mapping attributes.

The "Type" values are **S** for string, **N** for numeric, and **D** for the type of the data variable. The "Use" values are **G** for global, **C** for variables containing coordinate data, **D** for variables containing non-coordinate data, and **-** for variables with a special purpose. "Links" indicates the location of the attribute"s original definition (first link) and sections where the attribute is discussed in this document (additional links as necessary).
The "Type" values are **S** for string, **N** for numeric, and **D** for the type of the data variable. The "Use" values are **G** for global, **Gr** for applying to groups, **C** for variables containing coordinate data, **D** for variables containing non-coordinate data, **M** for geometry container variables, and **-** for variables with a special purpose. "Links" indicates the location of the attribute"s original definition (first link) and sections where the attribute is discussed in this document (additional links as necessary).

[[table-attributes]]
.Attributes
Expand Down Expand Up @@ -107,7 +107,7 @@ formula in the definition.

| **`coordinates`**
| S
| D
| D, M
| <<coordinate-system>>, <<labels>>, <<alternative-coordinates>>
| Identifies auxiliary coordinate variables, label variables, and alternate coordinate variables.

Expand All @@ -130,7 +130,7 @@ formula in the definition.
| S
| G
| <<featureType>>
| Specifies the type of discrete sampling geometry to which the data in the file belongs, and implies that all data variables in the file contain collections of features of that type.
| Specifies the type of discrete sampling geometry to which the data in the scope of this attribute belongs, and implies that all data variables in the scope of this attribute contain collections of features of that type.

| **`flag_masks`**
| D
Expand All @@ -156,15 +156,27 @@ formula in the definition.
| <<parametric-vertical-coordinate>>
| Identifies variables that correspond to the terms in a formula.

| **`geometry`**
| S
| C, D
| <<geometries>>
| Identifies a variable that defines geometry.

| **`geometry_type`**
| S
| M
| <<geometries>>
| Indicates the type of geometry present.

| **`grid_mapping`**
| S
| D
| D, M
| <<grid-mappings-and-projections>>
| Identifies a variable that defines a grid mapping.

| **`history`**
| S
| G
| G, Gr
| link:$$http://www.unidata.ucar.edu/software/netcdf/docs/attribute_conventions.html$$[NUG Appendix A, "Attribute Conventions"]
| List of the applications that have modified the original data.

Expand All @@ -180,6 +192,12 @@ formula in the definition.
| <<description-of-file-contents>>
| Where the original data was produced.

| **`interior_ring`**
| S
| M
| <<geometries>>
| Identifies a variable that indicates if polygon parts are interior rings (i.e., holes) or not.

| **`leap_month`**
| N
| C
Expand All @@ -198,7 +216,6 @@ formula in the definition.
| link:$$http://www.unidata.ucar.edu/software/netcdf/docs/attribute_conventions.html$$[NUG Appendix A, "Attribute Conventions"], and <<long-name>>
| A descriptive name that indicates a variable"s content. This name is not standardized.


| **`missing_value`**
| D
| C, D
Expand All @@ -211,6 +228,30 @@ formula in the definition.
| <<calendar>>
| Specifies the length of each month in a non-leap year for a user defined calendar.

| **`node_coordinates`**
| S
| M
| <<geometries>>
| Identifies variables that contain geometry node coordinates.

| **`node_count`**
| S
| M
| <<geometries>>
| Identifies a variable indicating the count of nodes per geometry.

| **`nodes`**
| S
| C
| <<geometries>>
| Identifies a coordinate node variable.

| **`part_node_count`**
| S
| M
| <<geometries>>
| Identifies a variable providing the count of nodes per geometry part.

| **`positive`**
| S
| C
Expand Down Expand Up @@ -255,7 +296,7 @@ formula in the definition.

| **`title`**
| S
| G
| G, Gr
| link:$$http://www.unidata.ucar.edu/software/netcdf/docs/attribute_conventions.html$$[NUG Appendix A, "Attribute Conventions"]
| Short description of the file contents.

Expand Down
1 change: 0 additions & 1 deletion appe.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,4 @@ respect to the specified dimension.
| `variance` | __u^2^__ | Variance
|===============



4 changes: 2 additions & 2 deletions appf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ to a reference direction.
Corresponds to an OGC WKT VERT_DATUM name. This attribute and **`geoid_name`** cannot
both be specified.

| **`grid_mapping_name`** | N
| **`grid_mapping_name`** | S
| The name used to identify the grid mapping.

| **`grid_north_pole_latitude`** | N
Expand Down Expand Up @@ -622,7 +622,7 @@ to a reference direction.

| **`straight_vertical_longitude_from_pole`** | N
| The longitude (degrees_east) to be oriented straight up from the North or
South Pole. Domain: **`-180.0 &le; straight_vertical_longitude_from_pole< 180.0`**
South Pole. Domain: **`-180.0 &lt;= straight_vertical_longitude_from_pole &lt; 180.0`**

| **`towgs84`** | N
| This indicates a list of up
Expand Down
Loading

0 comments on commit 3f0e55a

Please sign in to comment.