Skip to content

Commit

Permalink
Remove in-development warnings and add GH discussion info.
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewdnolan committed Jan 13, 2025
1 parent 9a70b81 commit cd246cb
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 7 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
24 changes: 21 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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>
```

0 comments on commit cd246cb

Please sign in to comment.