Skip to content

Commit

Permalink
Revert official project name from "XCDAT" to "xCDAT" (#231)
Browse files Browse the repository at this point in the history
* Update "XCDAT" refs to "xCDAT"
* Update xCDAT logo
  • Loading branch information
tomvothecoder authored Apr 27, 2022
1 parent 557343c commit 240e47a
Show file tree
Hide file tree
Showing 16 changed files with 91 additions and 91 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug Report
description: File a bug report to help us improve XCDAT
description: File a bug report to help us improve xCDAT
title: "[Bug]: "
labels: ["Type: Bug"]
assignees: []
Expand Down Expand Up @@ -56,6 +56,6 @@ body:
attributes:
label: Environment
description: |
Paste your XCDAT version and the output `xr.show_versions()` here
Paste your xCDAT version and the output `xr.show_versions()` here
validations:
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: Usage question
url: https://github.com/XCDAT/xcdat/discussions
url: https://github.com/xCDAT/xcdat/discussions
about: |
Ask questions and discuss with other community members here.
If you have a question like "How do I perform geospatial averaging?" then
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Documentation Update
description: Update XCDAT documentation
description: Update xCDAT documentation
title: "[DOC]: "
labels: ["Type: Documentation"]
assignees: []
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feature Request
description: Suggest an idea for XCDAT
description: Suggest an idea for xCDAT
title: "[FEATURE]: "
labels: ["Type: Enhancement"]
assignees: []
Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/XCDAT/xcdat/issues.
Report bugs at https://github.com/xCDAT/xcdat/issues.

If you are reporting a bug, please include:

Expand All @@ -34,13 +34,13 @@ Look through the GitHub issues for features. Any unassigned issues tagged with "
Write Documentation
~~~~~~~~~~~~~~~~~~~

XCDAT could always use more documentation, whether as part of the
official XCDAT docs, or directly in the code through docstrings.
xCDAT could always use more documentation, whether as part of the
official xCDAT docs, or directly in the code through docstrings.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/XCDAT/xcdat/issues.
The best way to send feedback is to file an issue at https://github.com/xCDAT/xcdat/issues.

If you are proposing a feature:

Expand Down Expand Up @@ -91,7 +91,7 @@ at the commit level before submitting code reviews.

Get Started
------------
Ready to contribute? Here's how to set up XCDAT for local development.
Ready to contribute? Here's how to set up xCDAT for local development.

VSCode
~~~~~~
Expand All @@ -102,7 +102,7 @@ Get VSCode here: https://code.visualstudio.com

VSCode Setup
^^^^^^^^^^^^
XCDAT includes a VSCode settings file (``.vscode/setting.json``). This file automatically configures your IDE with the Conda development environment, quality assurance tools, code line-length rulers, and more.
xCDAT includes a VSCode settings file (``.vscode/setting.json``). This file automatically configures your IDE with the Conda development environment, quality assurance tools, code line-length rulers, and more.

Just open the cloned repository in VSCode and you are set!

Expand Down Expand Up @@ -138,7 +138,7 @@ Local Development

2. Fork the ``xcdat`` repo on GitHub.

- If you are a maintainer, you can clone and branch directly from the root repository here: https://github.com/XCDAT/xcdat
- If you are a maintainer, you can clone and branch directly from the root repository here: https://github.com/xCDAT/xcdat

3. Clone your fork locally::

Expand Down Expand Up @@ -242,15 +242,15 @@ When you open a pull request on GitHub, there is a template available for use.
Style Guide
-----------

XCDAT integrates the Black code formatter for code styling. If you want to learn more, please read about it `here <https://black.readthedocs.io/en/stable/the_black_code_style.html>`__.
xCDAT integrates the Black code formatter for code styling. If you want to learn more, please read about it `here <https://black.readthedocs.io/en/stable/the_black_code_style.html>`__.

XCDAT also leverages `Python Type Annotations <https://docs.python.org/3.8/library/typing.html>`_ to help the project scale.
xCDAT also leverages `Python Type Annotations <https://docs.python.org/3.8/library/typing.html>`_ to help the project scale.
`mypy <https://mypy.readthedocs.io/en/stable/introduction.html>`_ performs optional static type checking through pre-commit.

Testing
-------
Testing your local changes are important to ensure long-term maintainability and extensibility of the project.
Since XCDAT is an open source library, we aim to avoid as many bugs as possible from reaching the end-user.
Since xCDAT is an open source library, we aim to avoid as many bugs as possible from reaching the end-user.

To get started, here are guides on how to write tests using pytest:

Expand Down Expand Up @@ -353,7 +353,7 @@ $ pytest tests.test_xcdat
FAQs
----

What is xarray and how do I extend xarray for XCDAT?
What is xarray and how do I extend xarray for xCDAT?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* https://xarray.pydata.org/en/stable/why-xarray.html
* https://xarray.pydata.org/en/stable/internals.html#extending-xarray
Expand Down
82 changes: 41 additions & 41 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,65 +9,65 @@ New Features
~~~~~~~~~~~~

- Add support for spatial averaging parallelism via Dask by @pochedls
in https://github.com/XCDAT/xcdat/pull/132
in https://github.com/xCDAT/xcdat/pull/132
- Refactor spatial averaging with more robust handling of longitude
spanning prime meridian by @pochedls in
https://github.com/XCDAT/xcdat/pull/152
https://github.com/xCDAT/xcdat/pull/152
- Update xcdat.open_mfdataset time decoding logic by @pochedls in
https://github.com/XCDAT/xcdat/pull/161
https://github.com/xCDAT/xcdat/pull/161
- Add function to swap dataset longitude axis orientation by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/145
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/145
- Add utility functions by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/205
https://github.com/xCDAT/xcdat/pull/205
- Add temporal utilities and averaging functionalities by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/107
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/107

Bug Fixes
~~~~~~~~~

- Add exception for coords of len <= 1 or multidimensional coords in
``fill_missing_bounds()`` by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/141
https://github.com/xCDAT/xcdat/pull/141
- Update ``open_mfdataset()`` to avoid data vars dim concatenation by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/143
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/143
- Fix indexing on axis keys using generic map (related to spatial
averaging) by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/172
https://github.com/xCDAT/xcdat/pull/172

Breaking Changes
~~~~~~~~~~~~~~~~

- Rename accessor classes and methods for API consistency by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/142
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/142
- Rename ``fill_missing_bounds()`` to ``add_missing_bounds()`` by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/157
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/157
- Remove data variable inference API by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/196
https://github.com/xCDAT/xcdat/pull/196
- Rename spatial file and class by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/207
https://github.com/xCDAT/xcdat/pull/207

Documentation
~~~~~~~~~~~~~

- update README by @chengzhuzhang in
https://github.com/XCDAT/xcdat/pull/127
- Update readme by @lee1043 in https://github.com/XCDAT/xcdat/pull/129
https://github.com/xCDAT/xcdat/pull/127
- Update readme by @lee1043 in https://github.com/xCDAT/xcdat/pull/129
- Update ``HISTORY.rst`` and fix docstrings by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/139
https://github.com/xCDAT/xcdat/pull/139
- Update ``README.rst`` content and add logo by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/153
https://github.com/xCDAT/xcdat/pull/153
- Update API Reference docs to list all APIs by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/155
https://github.com/xCDAT/xcdat/pull/155
- Add ``config.yml`` for issue templates with link to discussions by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/176
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/176
- Add FAQs page to docs by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/181
https://github.com/xCDAT/xcdat/pull/181
- Fix syntax of code examples from PR #181 by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/182
https://github.com/xCDAT/xcdat/pull/182
- Replace markdown issue templates with GitHub yml forms by
@tomvothecoder in https://github.com/XCDAT/xcdat/pull/186
@tomvothecoder in https://github.com/xCDAT/xcdat/pull/186
- Update ``README.rst``, ``index.rst``, and ``project_maintenance.rst``
by @tomvothecoder in https://github.com/XCDAT/xcdat/pull/211
by @tomvothecoder in https://github.com/xCDAT/xcdat/pull/211

Deprecations
~~~~~~~~~~~~
Expand All @@ -76,45 +76,45 @@ Internal Changes
~~~~~~~~~~~~~~~~

- Update logger levels to debug by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/148
https://github.com/xCDAT/xcdat/pull/148
- Update and remove logger debug messages by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/193
https://github.com/xCDAT/xcdat/pull/193

DevOps
~~~~~~

- Add ``requires_dask`` decorator for tests by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/177
https://github.com/xCDAT/xcdat/pull/177
- Update dependencies in ``setup.py`` and ``dev.yml`` by @tomvothecoder
in https://github.com/XCDAT/xcdat/pull/174
in https://github.com/xCDAT/xcdat/pull/174
- Add matrix testing and ci specific conda env by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/178
https://github.com/xCDAT/xcdat/pull/178
- Suppress xarray warning in test suite by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/179
https://github.com/xCDAT/xcdat/pull/179
- Drop support for Python 3.7 by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/187
https://github.com/xCDAT/xcdat/pull/187
- Update conda env dependencies by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/189
https://github.com/xCDAT/xcdat/pull/189
- Add deps to ``pre-commit`` ``mypy`` and fix issues by @tomvothecoder
in https://github.com/XCDAT/xcdat/pull/191
in https://github.com/xCDAT/xcdat/pull/191
- Add ``matplotlib`` to dev env, update ``ci.yml`` and add Python 3.10
to build workflow by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/203
https://github.com/xCDAT/xcdat/pull/203
- Replace conda with mamba in rtd build by @tomvothecoder in
https://github.com/XCDAT/xcdat/pull/209
https://github.com/xCDAT/xcdat/pull/209

New Contributors
~~~~~~~~~~~~~~~~

- @chengzhuzhang made their first contribution in
https://github.com/XCDAT/xcdat/pull/127
https://github.com/xCDAT/xcdat/pull/127
- @lee1043 made their first contribution in
https://github.com/XCDAT/xcdat/pull/129
https://github.com/xCDAT/xcdat/pull/129
- @pochedls made their first contribution in
https://github.com/XCDAT/xcdat/pull/132
https://github.com/xCDAT/xcdat/pull/132

**Full Changelog**:
https://github.com/XCDAT/xcdat/compare/v0.1.0...v0.2.0
https://github.com/xCDAT/xcdat/compare/v0.1.0...v0.2.0

v0.1.0 (7 October 2021)
------------------------
Expand Down Expand Up @@ -164,8 +164,8 @@ Documentation
DevOps
~~~~~~

- 100% code coverage (https://app.codecov.io/gh/XCDAT/xcdat)
- GH Actions for CI/CD build (https://github.com/XCDAT/xcdat/actions)
- 100% code coverage (https://app.codecov.io/gh/xCDAT/xcdat)
- GH Actions for CI/CD build (https://github.com/xCDAT/xcdat/actions)
- Pytest and pytest-cov for test suite

**Full Changelog**: https://github.com/XCDAT/xcdat/commits/v0.1.0
**Full Changelog**: https://github.com/xCDAT/xcdat/commits/v0.1.0
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. raw:: html

<p align="center">
<img src="./docs/_static/xcdat_logo.png" alt="XCDAT logo"/>
<img src="./docs/_static/xcdat_logo.png" alt="xCDAT logo"/>
</p>

.. container::
Expand All @@ -25,12 +25,12 @@
:target: https://anaconda.org/conda-forge/xcdat
.. |platforms| image:: https://img.shields.io/conda/pn/conda-forge/xcdat.svg
:target: https://anaconda.org/conda-forge/xcdat
.. |CI/CD Build Workflow| image:: https://github.com/XCDAT/xcdat/actions/workflows/build_workflow.yml/badge.svg
:target: https://github.com/XCDAT/xcdat/actions/workflows/build_workflow.yml
.. |CI/CD Build Workflow| image:: https://github.com/xCDAT/xcdat/actions/workflows/build_workflow.yml/badge.svg
:target: https://github.com/xCDAT/xcdat/actions/workflows/build_workflow.yml
.. |docs| image:: https://readthedocs.org/projects/xcdat/badge/?version=latest
:target: https://xcdat.readthedocs.io/en/latest/?badge=latest
.. |Codecov| image:: https://codecov.io/gh/XCDAT/xcdat/branch/main/graph/badge.svg?token=UYF6BAURTH
:target: https://codecov.io/gh/XCDAT/xcdat
.. |Codecov| image:: https://codecov.io/gh/xCDAT/xcdat/branch/main/graph/badge.svg?token=UYF6BAURTH
:target: https://codecov.io/gh/xCDAT/xcdat
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
Expand All @@ -40,7 +40,7 @@
.. |Checked with mypy| image:: http://www.mypy-lang.org/static/mypy_badge.svg
:target: http://mypy-lang.org/

XCDAT is an extension of `xarray`_ for climate data analysis on structured grids.
xCDAT is an extension of `xarray`_ for climate data analysis on structured grids.
It serves as a spiritual successor to the Community Data Analysis Tools (`CDAT`_) library.

.. _xarray: https://github.com/pydata/xarray
Expand All @@ -49,7 +49,7 @@ It serves as a spiritual successor to the Community Data Analysis Tools (`CDAT`_
Planned Features
-----------------

XCDAT aims to provide utilities for general xarray usage and climate domain specific features.
xCDAT aims to provide utilities for general xarray usage and climate domain specific features.

These features include:

Expand Down Expand Up @@ -82,7 +82,7 @@ These features include:

- Operate on rectilinear and cuvilinear grids

- Parallelism of XCDAT features using Dask
- Parallelism of xCDAT features using Dask

Feature Criteria
~~~~~~~~~~~~~~~~
Expand Down
Binary file modified docs/_static/xcdat_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@
master_doc = "index"

# General information about the project.
project = "XCDAT"
copyright = "2021, XCDAT Developers"
author = "XCDAT Developers"
project = "xCDAT"
copyright = "2021, xCDAT Developers"
author = "xCDAT Developers"

# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
Expand Down Expand Up @@ -122,9 +122,9 @@
# sphinx_book_theme configurations
# https://sphinx-book-theme.readthedocs.io/en/latest/configure.html
html_logo = "_static/xcdat_logo.png"
html_title = "XCDAT Documentation"
html_title = "xCDAT Documentation"
html_theme_options = {
"repository_url": "https://github.com/XCDAT/xcdat",
"repository_url": "https://github.com/xCDAT/xcdat",
"repository_branch": "master",
"path_to_docs": "docs",
"use_edit_page_button": True,
Expand Down Expand Up @@ -168,15 +168,15 @@
# (source start file, target name, title, author, documentclass
# [howto, manual, or own class]).
latex_documents = [
(master_doc, "xcdat.tex", "XCDAT Documentation", "Tom Vo", "manual"),
(master_doc, "xcdat.tex", "xCDAT Documentation", "Tom Vo", "manual"),
]


# -- Options for manual page output ------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "xcdat", "XCDAT Documentation", [author], 1)]
man_pages = [(master_doc, "xcdat", "xCDAT Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------
Expand All @@ -188,7 +188,7 @@
(
master_doc,
"xcdat",
"XCDAT Documentation",
"xCDAT Documentation",
author,
"xcdat",
"One line description of project.",
Expand Down
Loading

0 comments on commit 240e47a

Please sign in to comment.