Merge pull request #26 from andrewdnolan/update-to-1.0.0

Update to 1.0.0

Author: andrewdnolan

README.md

@@ -1,12 +1,18 @@
 # Mosaic
 
-> :warning: **This package in under early development and not ready for production use, yet.**
-
-`mosaic` provides the functionality to visualize unstructured mesh data on it's native grid within `matplotlib`.
-Currently `mosaic` only supports MPAS meshes, but future work will add support for other unstructured meshes used in `E3SM`.
+`mosaic` provides the functionality to visualize unstructured [MPAS](https://mpas-dev.github.io/)
+mesh data on it's native grid within `matplotlib`. Currently MPAS meshes are the
+only unstructured meshes used in `E3SM` that `mosaic` supports, but future work
+will add support for others.
 
 ## Documentation
 
 The latest `mosaic` documentation can be found here:
 
 https://docs.e3sm.org/mosaic/
+
+## Requests for help
+
+If you have any trouble with `mosaic`, especially problems plotting your `MPAS`
+mesh of choice, please reach out via [GitHub discussions](https://github.com/E3SM-Project/mosaic/discussions)
+under the ["Q&A" category](https://github.com/E3SM-Project/mosaic/discussions/categories/q-a).

docs/index.md

@@ -2,10 +2,21 @@
 
 # Mosaic
 
-> ⚠️  **This package in under early development and not ready for production use, yet.**
+`mosaic` provides the functionality to visualize unstructured [MPAS](https://mpas-dev.github.io/)
+mesh data on it's native grid within `matplotlib`. Currently MPAS meshes are the
+only unstructured meshes used in `E3SM` that `mosaic` supports, but future work
+will add support for others.
 
-`mosaic` provides the functionality to visualize unstructured mesh data on it's native grid within `matplotlib`. 
-Currently `mosaic` only supports [MPAS](https://mpas-dev.github.io/) meshes, but future work will add support for other unstructured meshes used in `E3SM`.
+:::{admonition} Please reach out with any problems!
+:class: tip
+
+If you have any trouble with `mosaic`, especially problems plotting your `MPAS` 
+mesh of choice, please reach out via [GitHub discussions](https://github.com/E3SM-Project/mosaic/discussions)
+under the ["Q&A" category](https://github.com/E3SM-Project/mosaic/discussions/categories/q-a).
+
+If you suspect you've found a bug in `mosaic` feel free to open an issue on
+[GitHub](https://github.com/E3SM-Project/mosaic/issues).
+:::
 
 ```{toctree}
 :maxdepth: 2
@@ -23,3 +34,10 @@ developers_guide/quick_start
 developers_guide/api
 ```
 
+```{toctree}
+:maxdepth: 1
+:hidden:
+:caption: Community:
+
+GitHub disscusions <https://github.com/E3SM-Project/mosaic/discussions>
+```

mosaic/version.py

@@ -1,2 +1,2 @@
-__version_info__ = (0, 2, 0)
+__version_info__ = (1, 0, 0)
 __version__ = '.'.join(str(vi) for vi in __version_info__)

pyproject.toml

@@ -24,6 +24,7 @@ dependencies = [
     "pooch",
     "pyproj",
     "scipy",
+    "shapely",
     "tqdm",
     "xarray",
 ]
@@ -32,7 +33,7 @@ dependencies = [
 docs = [
     # building documentation
     "sphinx",
-    "myst-parser",
+    "myst-nb",
     "sphinx-book-theme",
     "sphinx-copybutton",
     "sphinx-remove-toctrees",
@@ -41,8 +42,9 @@ docs = [
 dev = [
     # linting and testing
     "pip",
+    "pytest",
+    "pytest-timeout",
     "isort",
-    "flynt",
     "flake8",
     "mypy",
     "pre-commit",