diff --git a/README.md b/README.md index ea853620..e234a95f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -

Antarctic-plots

+

Antarctic-Plots

Functions to automate Antarctic data visualization

-Documentation (dev-version) +Documentation Link

+ +

Binder link @@ -43,28 +45,44 @@ alt="Zenodo DOI" Documentation Status

+ ![](docs/cover_fig.png) + + ## Disclaimer

🚨 **This package is in early stages of design and implementation.** 🚨

-I welcome any feedback, ideas, or contributions! Please contact us on the [Github discussions page](https://github.com/mdtanker/antarctic_plots/discussions) or submit an [issue on Github](https://github.com/mdtanker/antarctic_plots/issues) for problems or feature ideas. +I welcome any feedback, ideas, or contributions! Please contact us on the +[GitHub discussions page](https://github.com/mdtanker/antarctic_plots/discussions) +or submit an +[issue on GitHub](https://github.com/mdtanker/antarctic_plots/issues) for +problems or feature ideas. ## About -The **Antarctic-plots** python package provides some basic tools for creating maps and plots specific to Antarctica. It includes code to download common continent-wide datasets (i.e. Bedmap2, AntGG, ADMAP), and visualize them in a variety of ways, including cross sections and maps. +The **Antarctic-Plots** python package provides some basic tools to help in +conducting Antarctic research. You can use it to download common datasets (i.e. +BedMachine, Bedmap2, MODIA MoA), create maps and plots specific to Antarctica, +and visualize data with multiple methods. -Check out our [Documentation](https://antarctic-plots.readthedocs.io/en/latest/) for instructions on installing and using the package. - -Feel free to use, share, modify, and contribute to this project. I've mostly made this for personal usage so expect significant changes and hopefully I'll implement some tests and more Gallery examples soon. +Feel free to use, share, modify, and +[contribute](https://antarctic-plots.readthedocs.io/en/latest/contribute.html) +to this project. I've mostly made this for personal usage so expect significant +changes. Hopefully I'll implement more tests and Gallery examples soon. ## Project goals -Below is a list of some features I hope to eventually include. Feel free to make a feature request through [Github Issues](https://github.com/mdtanker/antarctic_plots/issues/new/choose). +Below is a list of some features I hope to eventually include. Feel free to make +a feature request through +[GitHub Issues](https://github.com/mdtanker/antarctic_plots/issues/new/choose). + +- Create 3D interactive models to help visualize data. +- Include more Antarctic datasets to aid in download and storage. +- Additional projections and possible support for the Arctic region as well. -* Create 3D interactive models to help visualize data. -* Include more Antarctic datasets to aid in download and storage. + diff --git a/docs/index.md b/docs/index.md index 11c05e6c..971bb6e9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,70 +1,137 @@ -# Antarctic-plots +# Antarctic-Plots Functions to automate Antarctic data visualization -

- - Binder link -

- -

- - - - - - - - - -

- - - - - - -Documentation Status -

- -![](cover_fig.png) - -## Disclaimer - -

-🚨 **This package is in early stages of design and implementation.** 🚨 -

- -I welcome any feedback, ideas, or contributions! Please contact us on the [Github discussions page](https://github.com/mdtanker/antarctic_plots/discussions) or submit an [issue on Github](https://github.com/mdtanker/antarctic_plots/issues) for problems or feature ideas. - -## About - -The **Antarctic-plots** python package provides some basic tools to help in conducting Antarctic research. You can use it to download common datasets (i.e. BedMachine, Bedmap2, MODIA MoA), create maps and plots specific to Antarctica, and visualize data with multiple methods. - -Check out our [Documentation](https://antarctic-plots.readthedocs.io/en/latest/) for instructions on installing and using the package. - -Feel free to use, share, modify, and [contribute](https://antarctic-plots.readthedocs.io/en/latest/contribute.html) to this project. I've mostly made this for personal usage so expect significant changes. Hopefully I'll implement more tests and Gallery examples soon. - -## Project goals - -Below is a list of some features I hope to eventually include. Feel free to make a feature request through [Github Issues](https://github.com/mdtanker/antarctic_plots/issues/new/choose). - -* Create 3D interactive models to help visualize data. -* Include more Antarctic datasets to aid in download and storage. -* Additional projections and possible support for the Arctic region as well. - -```{tableofcontents} +```{include} ../README.md +:start-after: +:end-before: +``` + +```{image} cover_fig.png +:alt: cover figure +:width: 400px +:align: center +``` + +```{include} ../README.md +:start-after: +:end-before: +``` + + +```{toctree} +:maxdepth: 1 +:hidden: +overview +install +``` + +```{toctree} +:maxdepth: 1 +:hidden: +:caption: đŸšļ Tutorials +tutorial/index.md +``` + +```{toctree} +:maxdepth: 1 +:hidden: +:caption: 📚 Gallery +gallery/index.md +``` + +```{toctree} +:maxdepth: 1 +:hidden: +:caption: Tips +tips.ipynb +``` + +```{toctree} +:maxdepth: 2 +:hidden: +:caption: 📖 Reference documentation +api/antarctic_plots +citing.md +changelog.md +references.rst +``` + +```{toctree} +:maxdepth: 1 +:hidden: +:caption: ℹī¸ Other resources +contributing.md +Source code on GitHub +``` + + +::::{grid} 2 +:::{grid-item-card} {octicon}`rocket` Getting started? +:text-align: center +New to Antarctic-Plots? Start here! +```{button-ref} overview + :click-parent: + :color: primary + :outline: + :expand: +``` +::: + +:::{grid-item-card} {octicon}`comment-discussion` Need help? +:text-align: center +Start a discussion on GitHub! +```{button-link} https://github.com/mdtanker/antarctic_plots/discussions + :click-parent: + :color: primary + :outline: + :expand: + Discussions +``` +::: + +:::{grid-item-card} {octicon}`file-badge` Reference documentation +:text-align: center +A list of modules and functions +```{button-ref} api/antarctic_plots + :click-parent: + :color: primary + :outline: + :expand: +``` +::: + +:::{grid-item-card} {octicon}`bookmark` Using Antarctic-Plots for research? +:text-align: center +Citations help support our work +```{button-ref} citing + :click-parent: + :color: primary + :outline: + :expand: +``` +::: +:::: + + +```{admonition} Early-stages of development +:class: seealso + +This package is at the very beginning of it's development! This means that we are still adding a lot of new features and sometimes we +make changes to the ones we already have while we try to improve the +software based on users' experience, test new ideas, take better design +decisions, etc. +Some of these changes could be **backwards incompatible**. Keep that in +mind before you update Antarctic-Plots to a newer version. +``` + +```{admonition} How to contribute +:class: seealso + +Please, read our [Contributor Guide](https://github.com/mdtanker/antarctic_plots/blob/main/.github/CONTRIBUTING.md) to learn +how you can contribute to the project. +``` + +```{note} +*Many parts of this documentation was adapted from the* [Fatiando project](https://www.fatiando.org/). ```