Skip to content

Commit

Permalink
Merge branch 'generate2Darray' of https://github.com/jukent/geocat-viz
Browse files Browse the repository at this point in the history
…into generate2Darray
  • Loading branch information
jukent committed Nov 6, 2023
2 parents 72cb0cd + b48dfda commit 398abfb
Show file tree
Hide file tree
Showing 14 changed files with 553 additions and 71 deletions.
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ apply to this PR, comment it out or delete it. -->
Thank you so much for your PR! To help us review your contribution, please
consider the following points:
- A contributor's guide is available at https://geocat-viz.readthedocs.io/en/latest/contrib.html
- Fork this repository and open the PR from your fork. Do not directly work on
the NCAR/geocat-viz repository.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
fail-fast: false
matrix:
os: [ "ubuntu-latest", "macos-latest"]
python-version: [ "3.8", "3.9", "3.10" ]
python-version: [ "3.9", "3.10", "3.11" ]
steps:
- name: Cancel previous runs
uses: styfle/[email protected]
Expand Down
82 changes: 82 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Code of Conduct

## Our Pledge

We, as contributors, creators, stewards, and maintainers (participants), of GeoCAT-viz pledge to make participation in our
project and community a safe, productive, welcoming and inclusive experience for everyone. All participants are required
to abide by this Code of Conduct. This includes respectful treatment of everyone regardless of age, body size, disability,
ethnicity, gender identity or expression, level of experience, nationality, political affiliation, veteran status, pregnancy,
genetic information, physical appearance, race, religion, or sexual orientation, as well as any other characteristic protected
under applicable US federal or state law.

## Our Standards

Examples of behaviors that contribute to a positive environment include:

- All participants are treated with respect and consideration, valuing a diversity of views and opinions
- Be considerate, respectful, and collaborative
- Communicate openly with respect for others, critiquing ideas rather than individuals and gracefully accepting criticism
- Acknowledging the contributions of others
- Avoid personal attacks directed toward other participants
- Be mindful of your surroundings and of your fellow participants
- Alert project administrators if you notice a dangerous situation or someone in distress
- Respect the rules and policies of the project and venue

Examples of unacceptable behavior include, but are not limited to:

- Harassment, intimidation, or discrimination in any form
- Physical, verbal, or written abuse by anyone to anyone, including repeated use of pronouns other than those requested
- Unwelcome sexual attention or advances
- Personal attacks directed at other guests, members, participants, etc.
- Publishing others’ private information, such as a physical or electronic address, without explicit permission
- Alarming, intimidating, threatening, or hostile comments or conduct
- Inappropriate use of nudity and/or sexual images
- Threatening or stalking anyone, including a participant
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Scope

This Code of Conduct applies to all spaces managed by GeoCAT whether they be physical, online or face-to-face.
This includes project code, code repository, associated web pages, documentation, mailing lists, project websites
and wiki pages, issue tracker, meetings, telecons, events, project social media accounts, and any other forums
created by the project team which the community uses for communication. In addition, violations of this Code of
Conduct outside these spaces may affect a person's ability to participate within them. Representation of a project
may be further defined and clarified by project maintainers.

## Community Responsibilities

Everyone in the community is empowered to respond to people who are showing unacceptable behavior. They can talk to
them privately or publicly. Anyone requested to stop unacceptable behavior is expected to comply immediately. If the
behavior continues concerns may be brought to the project administrators or to any other party listed in the Reporting
section below.

## Project Administrator Responsibilities

Project administrators are responsible for clarifying the standards of acceptable behavior and are encouraged to model
appropriate behavior and provide support when people in the community point out inappropriate behavior. Project
administrator(s) are normally the ones that would be tasked to carry out the actions in the Consequences section below.

## Reporting

Instances of unacceptable behavior can be brought to the attention of the project administrator(s) who may take any action
as outlined in the Consequences section below. However, making a report to a project administrator is not considered an
‘official report’ to UCAR.

## Consequences

Upon receipt of a complaint, the project administrator(s) may take any action deemed necessary and appropriate under the
circumstances. Such action can include things such as: removing, editing, or rejecting comments, commits, code, wiki edits,
email, issues, and other contributions that are not aligned to this Code of Conduct, or banning temporarily or permanently
any contributor for other behaviors that are deemed inappropriate, threatening, offensive, or harmful. Project administrators
also have the right to report violations to UCAR HR and/or UCAR’s Office of Diversity, Equity and Inclusion (ODEI), as well
as a participant’s home institution and/or law enforcement. In the event an incident is reported to UCAR, UCAR will follow
its Harassment Reporting and Complaint Procedure.

## Attribution

This Code of Conduct was originally adapted from the Contributor Covenant, version 1.4. We then aligned it with the UCAR
Participant Code of Conduct, which also borrows from the American Geophysical Union (AGU) Code of Conduct. The UCAR Participant
Code of Conduct applies to both UCAR employees as well as participants in activities run by UCAR. The original version of this
for all software projects that have strong management from UCAR or UCAR staff is available on the UCAR website at
[https://doi.org/10.5065/6w2c-a132](https://doi.org/10.5065/6w2c-a132). The date that it was adopted by this project was 2
October 2023. When responding to complaints, UCAR HR and ODEI will do so based on the latest published version.
57 changes: 1 addition & 56 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,56 +1 @@
Please first refer to [GeoCAT Contributor's Guide](https://geocat.ucar.edu/pages/contributing.html) for overall
contribution guidelines (such as detailed description of GeoCAT structure, forking, repository cloning,
branching, etc.). Once you determine that a function should be contributed under this repo, please refer to the
following contribution guidelines:


# Adding new utility functions to the Geocat-viz repo

1. Please check the followings to ensure that the functionality you are about to work on has not been ported yet:

- Functions implemented in `$GEOCAT_VIZ/src/geocat/viz/util/util.py`,

- The list of [GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues) and
[GeoCAT-examples Issues](https://github.com/NCAR/GeoCAT-examples/issues) to see if any of
the existing to-do items are something you might be interested in working on,

- If so, please comment (or self-assign the issue if you have permissions to do so) indicating that
you intend to work on it.

- Otherwise, you may create and self-assign an issue under
[GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues)
that describes need for the functionality you are planning to contribute.

2. Define a new function and implement it under the `$GEOCAT_VIZ/src/geocat/viz/util/util.py`.

# Adding new plotting utility functionality to the Geocat-viz repo

1. Please check the followings to ensure that the functionality you are about to work on has not been ported yet:

- Functions implemented in `$GEOCAT_VIZ/src/geocat/viz/`

- The list of [GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues) and
[GeoCAT-examples Issues](https://github.com/NCAR/GeoCAT-examples/issues) to see if any of
the existing to-do items are something you might be interested in working on,

- If so, please comment (or self-assign the issue if you have permissions to do so) indicating that
you intend to work on it.

- Otherwise, you may create and self-assign an issue under
[GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues)
that describes need for the functionality you are planning to contribute.

2. Determine which module is the best home for your new function.

- If necessary, create a new `.py` module under `$GEOCAT_VIZ/src/geocat/viz/`.

- Implement your plotting function inside the chosen module, making
use of the pre-defined parent classes if appropriate

3. Add new modules to the namespace by adding it to `$GEOCAT_VIZ/src/geocat/viz/__init__.py`

# Adding functionality to the User API Documentation

1. Add your new function to `GEOCAT_VIZ/docs/user_api/index.rst`.

2. Ensure that the function docstring has examples linking to relevant GeoCAT-Examples scripts.
The contributor's guide for GeoCAT-viz can be found in our [online documentation](https://geocat-viz.readthedocs.io/en/latest/contrib.html).
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ plotting packages. GeoCAT-viz functionality is used by

[GeoCAT Homepage](https://geocat.ucar.edu/)

[GeoCAT-viz Contributor's Guide](https://github.com/NCAR/geocat-viz/blob/main/CONTRIBUTING.md)
[GeoCAT-viz Contributor's Guide](https://geocat-viz.readthedocs.io/en/latest/contrib.html)

[GeoCAT-viz documentation on Read the Docs](https://geocat-viz.readthedocs.io)
[GeoCAT-viz Documentation on Read the Docs](https://geocat-viz.readthedocs.io)

# Installation instructions

Please see our documentation for [installation instructions](https://github.com/NCAR/geocat-viz/blob/main/INSTALLATION.md).
Please see our documentation for [installation instructions](https://geocat-viz.readthedocs.io/en/latest/installation.html).

# Citing GeoCAT-viz

Expand Down
4 changes: 2 additions & 2 deletions build_envs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ name: gv-docs
channels:
- conda-forge
dependencies:
- python>=3.8, <=3.10
- python>=3.9, <3.12
- cartopy
- cmaps
- matplotlib
- matplotlib<3.8
- pint
- pip
- pre-commit
Expand Down
4 changes: 2 additions & 2 deletions build_envs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ name: geocat_viz_build
channels:
- conda-forge
dependencies:
- python>=3.8, <=3.10
- python>=3.9, <3.12
- cartopy
- make
- matplotlib
- matplotlib<3.8
- sphinx
- pip
- cmaps
Expand Down
2 changes: 1 addition & 1 deletion build_envs/upstream-dev-environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: geocat_viz_upstream
channels:
- conda-forge
dependencies:
- python>=3.7
- python>=3.9
- geocat-comp
- cf_xarray>=0.3.1
- geocat-datafiles
Expand Down
Loading

0 comments on commit 398abfb

Please sign in to comment.