Merge pull request #216 from UXARRAY/prototype_redesign

Redesign

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,13 +18,14 @@ import uxarray as ux
 grid_path = "/path/to/grid.nc"
 data_path = "/path/to/data.nc"
 
-uxgrid = ux.Grid(grid_path)
+uxds = ux.open_dataset(grid_path, data_path)
 
 # this is how you use this function
-some_output = uxgrid.some_function()
+some_output = uxds.some_function()
 
 # this is another way to use this function
-other_output = uxgrid.some_function(some_param = True)
+other_output = uxds.some_function(some_param = True)
+
 ```
 
 ## PR Checklist

README.md

@@ -9,9 +9,9 @@
 
 UXarray aims to address the geoscience community need for tools that enable
 standard data analysis techniques to operate directly on unstructured grid
-data. UXarray will provide Xarray styled functions to better read in and use
+data. UXarray provides Xarray styled functions to better read in and use
 unstructured grid datasets that follow standard conventions, including UGRID,
-SCRIP, Exodus and shapefile formats.  This effort is a result of the
+MPAS, SCRIP, and Exodus formats.  This effort is a result of the
 collaboration between Project Raijin (NCAR and Pennsylvania State University)
 and the SEATS Project (Argonne National Laboratory, UC Davis, and Lawrence
 Livermore National Laboratory). The UXarray team welcomes other community
@@ -26,11 +26,11 @@ under the `Issues` tab in the UXarray repository.
 # Why is the name "UXarray"?
 
 We have created UXarray based on [Xarray](https://docs.xarray.dev/en/stable/)
-(via composition of a Xarray dataset object), a Pangeo ecosystem package
+(via inheritance of Xarray Dataset and DataArray classes), a Pangeo ecosystem package
 commonly-used for structured grids recognition, to support reading and
 recognizing unstructured grid model outputs. We picked the name "UXarray"
-and preferred to capitalize the first two letters to emphasize it is Xarray
-for Unstructured grids.
+(pronounced "you-ex-array") and preferred to capitalize the first two letters to
+emphasize it builds upon Xarray for Unstructured grids.
 
 # UXarray Functionality
 

docs/announcement.rst

@@ -0,0 +1,23 @@
+.. currentmodule:: uxarray
+
+.. _announcement:
+
+Announcement
+============
+
+v2023.6.0 of UXarray includes significant code design & API changes
+to address the user needs and requests better. Further information
+about the design change can be found in several places such as:
+
+- v2023.6.0 Release notes
+
+- `GitHub Discussion - UXarray Redesign Thoughts and
+  Options <https://github.com/UXARRAY/uxarray/discussions/185>`_
+
+- `GitHub Pull Request #216 -
+  Redesign <https://github.com/UXARRAY/uxarray/pull/216>`_ that implemented the new design with all the code and documentation changes
+
+- `Usage Examples <https://uxarray.readthedocs.io/en/latest/examples.html>`_ can be utilized to get to know the new design
+
+
+Feel free to reach out to us with any questions/concerns.

docs/api.rst

@@ -5,8 +5,10 @@
 API Reference
 =============
 
-Below user API and internal API pages show already-implemented Uxarray functionality.
-You can also check the draft `Uxarray API
+
+
+Below user API and internal API pages show already-implemented UXarray functionality.
+You can also check the draft `UXarray API
 <https://github.com/UXARRAY/uxarray/blob/main/docs/user_api/uxarray_api.md>`_
 documentation to see the tentative whole API and let us know if you have any feedback!
 

docs/citation.rst

@@ -2,17 +2,17 @@
 
 .. _citation:
 
-How to Cite Uxarray
+How to Cite UXarray
 ===================
 
-Cite Uxarray using the following text:
+Cite UXarray using the following text:
 
-**UXARRAY Organization. (Year).
-Uxarray (version \<version\>) [Software].
+**UXarray Organization. (Year).
+UXarray (version \<version\>) [Software].
 Project Raijin & Project SEATS. doi:10.5281/zenodo.<doi-part-per-version>.**
 
-Update the year, Uxarray version, and DOI part for UXarray version as appropriate. For example:
+Update the year, UXarray version, and DOI part for UXarray version as appropriate. For example:
 
-**UXARRAY Organization. (2021).
-Uxarray (version 0.0.2) [Software].
+**UXarray Organization. (2021).
+UXarray (version 0.0.2) [Software].
 Project Raijin & Project SEATS. doi:10.5281/zenodo.5658256.**

docs/examples.rst

@@ -5,16 +5,15 @@
 Usage Examples
 ==============
 
-Here's some examples of how to use the uxarray. We are always planning to add
-more examples! If you are interested in contributing your own examples, please
-see the :doc:`contributing`.
+Below is a list of usage examples showcasing how to use UXarray. If you are interested in contributing
+your own examples or suggesting one for us to create, please see the :doc:`contributing`.
 
 .. include:: notebook-examples.txt
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
-   examples/001-read-grid-data.ipynb
-   examples/002-access-grid-info.ipynb
+   examples/001-working-with-unstructured-grids.ipynb
+   examples/002-grid-topology.ipynb
    examples/003-area-calc.ipynb