From 485563e916aa52430cf4077bcb0e7a251ae6f902 Mon Sep 17 00:00:00 2001
From: Shenyulu <59901836+shenyulu@users.noreply.github.com>
Date: Wed, 4 Dec 2024 23:43:35 +0800
Subject: [PATCH] update: update index page
---
.pre-commit-config.yaml | 1 +
docs/requirements.txt | 1 +
docs/source/api_index/index.rst | 1 +
docs/source/conf.py | 1 +
docs/source/index.rst | 95 +++++++++++++++++++++-----------
docs/source/static_docs/cite.rst | 27 +++++++++
6 files changed, 95 insertions(+), 31 deletions(-)
create mode 100644 docs/source/static_docs/cite.rst
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index d003f1db..55e1469a 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -27,3 +27,4 @@ repos:
rev: 24.8.0
hooks:
- id: black
+ types: [python]
diff --git a/docs/requirements.txt b/docs/requirements.txt
index d1a2ae9e..220b01c5 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -37,3 +37,4 @@ sphinx-gallery == 0.17.1
sphinx-autoapi == 3.3.2
sphinx-copybutton == 0.5.2
sphinx-book-theme == 1.1.3
+sphinx_design == 0.6.1
diff --git a/docs/source/api_index/index.rst b/docs/source/api_index/index.rst
index f9370a8d..e4daedeb 100644
--- a/docs/source/api_index/index.rst
+++ b/docs/source/api_index/index.rst
@@ -53,6 +53,7 @@ Interpolation
easyclimate.interp.point2mesh
easyclimate.interp.mesh2mesh
easyclimate.interp.interp1d_vertical_model2pressure
+ easyclimate.interp.interp1d_vertical_pressure2altitude
Plot
----------------------------------------
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 5fecacd8..6f131fc8 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -49,6 +49,7 @@
# copy button
"sphinx_copybutton",
"sphinx.ext.githubpages",
+ "sphinx_design",
]
templates_path = ["_templates"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0f1e05df..bbf412d0 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,12 +1,12 @@
.. easyclimate documentation master file, created by
sphinx-quickstart on Mon Mar 20 14:33:30 2023.
-.. Easy climate
+.. Easy Climate
.. =======================================
.. .. image:: _static/easyclimate-logo.svg
-.. Easy climate is a Python library for processing spatial data (bathymetry, geophysics surveys, etc)
+.. Easy Climate is a Python library for processing spatial data (bathymetry, geophysics surveys, etc)
.. and interpolating it on regular grids (i.e., gridding).
.. Our core interpolation methods are inspired by machine-learning.
@@ -34,41 +34,80 @@
Easy Climate is just here to help you!
-Installation🛒
-------------------------
-You can do a direct install via `pip` by using:
+You can directly install it via `pip` by using 🛒
.. code-block:: bash
$ pip install easyclimate
-Online experience💻
-------------------------
-Just click on the link below and wait for the online environment to be configured before using the Easyclimate package on Jupyter notebook online.
-.. image:: https://mybinder.org/badge_logo.svg
- :target: https://mybinder.org/v2/gh/shenyulu/easyclimate/main?labpath=docs%2Fexample
+----
-How to cite📣
------------------------
+.. grid:: 1 2 1 2
+ :margin: 5 5 0 0
+ :padding: 0 0 0 0
+ :gutter: 4
-If you are using **Easy Climate** and would like to cite it in academic publication, we would certainly appreciate it. We recommend the following citations.
-We provide a `Zenodo citation and DOI `__ for this purpose:
+ .. grid-item-card:: :octicon:`info` Try Online🤗
+ :text-align: center
+ :class-title: sd-fs-5
+ :class-card: sd-p-3
-An example BibTeX entry:
+ New to Easy Climate? Try!
-.. code:: BibTeX
+ .. button-link:: https://mybinder.org/v2/gh/shenyulu/easyclimate/main?labpath=docs%2Fexample
+ :click-parent:
+ :color: primary
+ :outline:
+ :expand:
- @misc{easyclimate_v2024_11_0,
- author = {Yulu Shen},
- title = {easyclimate: v2024.11.0},
- month = dec,
- year = 2024,
- doi = {10.5281/zenodo.10279567},
- url = {https://doi.org/10.5281/zenodo.10279567}
- }
+ Binder Online Engine :octicon:`rocket`
+ .. grid-item-card:: :octicon:`comment-discussion` Need help?
+ :text-align: center
+ :class-title: sd-fs-5
+ :class-card: sd-p-3
+
+ Ask on our community channels.
+
+ .. button-link:: https://github.com/shenyulu/easyclimate/discussions
+ :click-parent:
+ :color: primary
+ :outline:
+ :expand:
+
+ Join the conversation :octicon:`link-external`
+
+ .. grid-item-card:: :octicon:`file-badge` Reference documentation
+ :text-align: center
+ :class-title: sd-fs-5
+ :class-card: sd-p-3
+
+ A list of modules and functions.
+
+ .. button-ref:: api
+ :ref-type: ref
+ :color: primary
+ :outline:
+ :expand:
+
+ .. grid-item-card:: :octicon:`bookmark` Using Easy Climate for research?
+ :text-align: center
+ :class-title: sd-fs-5
+ :class-card: sd-p-3
+
+ Citations help support our work!
+
+ .. button-ref:: citenote
+ :ref-type: ref
+ :color: primary
+ :outline:
+ :expand:
+
+ Cite our repository
+
+----
.. toctree::
:maxdepth: 1
@@ -116,6 +155,7 @@ An example BibTeX entry:
./api_index/index.rst
changes.md
+ ./static_docs/cite
.. toctree::
:maxdepth: 1
@@ -126,13 +166,6 @@ An example BibTeX entry:
Source code on GitHub
-Indices and tables🧭
-------------------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
.. caution::
🚨 This package is still undergoing rapid development. 🚨
diff --git a/docs/source/static_docs/cite.rst b/docs/source/static_docs/cite.rst
new file mode 100644
index 00000000..a2fab2d7
--- /dev/null
+++ b/docs/source/static_docs/cite.rst
@@ -0,0 +1,27 @@
+.. _citenote:
+
+Citing Easy Climate
+========================
+
+This is research software **made by scientists**. Citations help us justify the effort
+that goes into building and maintaining this project📣.
+
+If you used Easy Climate in your research, please consider citing our repository:
+
+ Shenyulu. (2024). shenyulu/easyclimate. (Version 2024.12.0) [Software]. Zenodo. https://doi.org/10.5281/zenodo.10279567
+
+This is an open-access repository and can be freely downloaded from
+https://doi.org/10.5281/zenodo.10279567
+
+Here is a Bibtex entry to make things easier if you're using Latex:
+
+.. code:: bibtex
+
+ @misc{easyclimate_v2024_12_0,
+ author = {Yulu Shen},
+ title = {easyclimate: v2024.12.0},
+ month = dec,
+ year = 2024,
+ doi = {10.5281/zenodo.10279567},
+ url = {https://doi.org/10.5281/zenodo.10279567}
+ }