Skip to content

Commit cd246cb

Browse files
committed
Remove in-development warnings and add GH discussion info.
1 parent 9a70b81 commit cd246cb

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# Mosaic
22

3-
> :warning: **This package in under early development and not ready for production use, yet.**
4-
5-
`mosaic` provides the functionality to visualize unstructured mesh data on it's native grid within `matplotlib`.
6-
Currently `mosaic` only supports MPAS meshes, but future work will add support for other unstructured meshes used in `E3SM`.
3+
`mosaic` provides the functionality to visualize unstructured [MPAS](https://mpas-dev.github.io/)
4+
mesh data on it's native grid within `matplotlib`. Currently MPAS meshes are the
5+
only unstructured meshes used in `E3SM` that `mosaic` supports, but future work
6+
will add support for others.
77

88
## Documentation
99

1010
The latest `mosaic` documentation can be found here:
1111

1212
https://docs.e3sm.org/mosaic/
13+
14+
## Requests for help
15+
16+
If you have any trouble with `mosaic`, especially problems plotting your `MPAS`
17+
mesh of choice, please reach out via [GitHub discussions](https://github.com/E3SM-Project/mosaic/discussions)
18+
under the ["Q&A" category](https://github.com/E3SM-Project/mosaic/discussions/categories/q-a).

docs/index.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,21 @@
22

33
# Mosaic
44

5-
> ⚠️ **This package in under early development and not ready for production use, yet.**
5+
`mosaic` provides the functionality to visualize unstructured [MPAS](https://mpas-dev.github.io/)
6+
mesh data on it's native grid within `matplotlib`. Currently MPAS meshes are the
7+
only unstructured meshes used in `E3SM` that `mosaic` supports, but future work
8+
will add support for others.
69

7-
`mosaic` provides the functionality to visualize unstructured mesh data on it's native grid within `matplotlib`.
8-
Currently `mosaic` only supports [MPAS](https://mpas-dev.github.io/) meshes, but future work will add support for other unstructured meshes used in `E3SM`.
10+
:::{admonition} Please reach out with any problems!
11+
:class: tip
12+
13+
If you have any trouble with `mosaic`, especially problems plotting your `MPAS`
14+
mesh of choice, please reach out via [GitHub discussions](https://github.com/E3SM-Project/mosaic/discussions)
15+
under the ["Q&A" category](https://github.com/E3SM-Project/mosaic/discussions/categories/q-a).
16+
17+
If you suspect you've found a bug in `mosaic` feel free to open an issue on
18+
[GitHub](https://github.com/E3SM-Project/mosaic/issues).
19+
:::
920

1021
```{toctree}
1122
:maxdepth: 2
@@ -23,3 +34,10 @@ developers_guide/quick_start
2334
developers_guide/api
2435
```
2536

37+
```{toctree}
38+
:maxdepth: 1
39+
:hidden:
40+
:caption: Community:
41+
42+
GitHub disscusions <https://github.com/E3SM-Project/mosaic/discussions>
43+
```

0 commit comments

Comments
 (0)