Skip to content

Commit

Permalink
change theme to furo
Browse files Browse the repository at this point in the history
  • Loading branch information
xumi1993 committed Feb 29, 2024
1 parent 0f57236 commit 194c6d8
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 37 deletions.
29 changes: 22 additions & 7 deletions .github/workflows/doc_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,45 @@ on:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
deploy:
build and deploy:
runs-on: macos-latest
defaults:
run:
shell: bash -l {0}

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Set branch name
id: vars
run: |
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
echo ::set-output name=branch::${{ github.event.pull_request.head.ref }}
else
echo ::set-output name=branch::"dev"
fi
- name: Cancel Previous Runs
uses: styfle/[email protected]

- name: Checkout
uses: actions/[email protected]
with:
ref: docs

- name: Setup Mambaforge
uses: conda-incubator/[email protected]
with:
activate-environment: docs
environment-file: environment.yml
# miniforge-variant: Mambaforge
# use-mamba: true


- name: Install Seispy
uses: actions/[email protected]
with:
ref: ${{ steps.vars.outputs.branch }}
run: |
pip install -e .
- name: Checkout to docs branch
uses: actions/[email protected]
with:
ref: docs

- name: Build documentation
run: |
make html
Expand Down
4 changes: 1 addition & 3 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ channels:
- conda-forge
- nodefaults
dependencies:
- python=3.10
- seispy
- pip
- sphinx
- sphinx-copybutton
- sphinx-design
- myst-nb
- pydata-sphinx-theme=0.8.1
- furo
- obspy
- numpydoc
- pip:
Expand Down
41 changes: 22 additions & 19 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@

# -- Project information -----------------------------------------------------

project = 'seispy'
project = 'Seispy'
copyright = '2020, Mijian Xu'
author = 'Mijian Xu'

# The short X.Y version
version = ''
version = '1.3.5'
# The full version, including alpha/beta/rc tags
release = 'latest'
release = version


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -101,16 +101,14 @@
#

html_baseurl = "seispy.xumijian.me"
# html_theme = 'classic'
html_theme = 'pydata_sphinx_theme'
html_theme = 'furo'
# html_theme = 'pydata_sphinx_theme'
# html_theme_path = [lsst_dd_rtd_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand All @@ -126,19 +124,24 @@
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
html_theme_options = {
"icon_links": [
{
# Label for this link
"name": "GitHub",
# URL where the link will redirect
"url": "https://github.com/xumi1993/seispy", # required
# Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
"icon": "fab fa-github-square",
# Whether icon should be a FontAwesome class, or a local file
# "type": "fontawesome OR local", # Default is fontawesome
}
]
# "icon_links": [
# {
# # Label for this link
# "name": "GitHub",
# # URL where the link will redirect
# "url": "https://github.com/xumi1993/seispy", # required
# # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
# "icon": "fab fa-github-square",
# # Whether icon should be a FontAwesome class, or a local file
# # "type": "fontawesome OR local", # Default is fontawesome
# }
# ],
"light_css_variables": {
"color-brand-primary": "#0080C4",
"color-brand-content": "#0080C4",
},
}

#
# html_sidebars = {}
html_favicon = os.path.abspath(os.path.join('.', '_static', 'seispy_100.png'))
Expand Down
2 changes: 1 addition & 1 deletion source/examples/ex-harmo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Background
Harmonic decomposition is an effective technique to separate anisotropic and dipping components from radius and transverse RFs ([Bianchi et al., 2010](https://doi.org/10.1029/2009JB007061])). This technique not only used to estimate azimuthal crustal anisotropy and crustal layer dipping , but used to extract isotropic component of RF for 1D RF inversion. In the Seispy, the command `rfharmo` is accessible for computing the harmonic decomposition, plotting different components after the decomposition, and save the isotropic component to a local SAC file.

```Code
```
usage: Harmonic decomposition for extracting anisotropic and isotropic features from the radial and transverse RFs [-h] [-t tb/te] [-s dt] [-o outpath] [-e enf] [-p figure_path] rfpath
positional arguments:
Expand Down
12 changes: 6 additions & 6 deletions source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@

# Seispy Documentation

[![License](https://img.shields.io/github/license/xumi1993/seispy)]()
[![](https://img.shields.io/github/last-commit/xumi1993/seispy)]()
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/xumi1993/seispy)]()
[![GitHub repo size](https://img.shields.io/github/repo-size/xumi1993/seispy)]()
![License](https://img.shields.io/github/license/xumi1993/seispy)
![Last commit](https://img.shields.io/github/last-commit/xumi1993/seispy)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/xumi1993/seispy)
![GitHub repo size](https://img.shields.io/github/repo-size/xumi1993/seispy)
[![DOI](https://zenodo.org/badge/41006349.svg)](https://zenodo.org/badge/latestdoi/41006349)

[![CRV test](https://github.com/xumi1993/seispy/actions/workflows/test.yml/badge.svg?branch=dev)](https://github.com/xumi1993/seispy/actions/workflows/test.yml)
Expand All @@ -26,8 +26,8 @@
[![PyPI](https://img.shields.io/pypi/v/python-seispy)](https://pypi.org/project/python-seispy/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-seispy)](https://pypi.org/project/python-seispy/)

[![GitHub stars](https://img.shields.io/github/stars/xumi1993/seispy?style=social)]()
[![](https://img.shields.io/github/forks/xumi1993/seispy?style=social)]()
[![GitHub stars](https://img.shields.io/github/stars/xumi1993/seispy?style=social)](https://github.com/xumi1993/seispy)
[![](https://img.shields.io/github/forks/xumi1993/seispy?style=social)](https://github.com/xumi1993/seispy)

Seispy is a graphical interface Python module for receiver function (RF) calculation and post-processing in seismological research. Automated workflows of RF calculations facilitate processing large volumes of different types of seismic data. The graphic user interface enables an intuitive and straightforward evaluation of RF quality control. Seispy contains the basic RF-based methods. Five main modules for the post-processing of RF are H-k stacking, crustal anisotropic estimation, harmonic decomposition, 2D and 3D common conversion point (CCP) stacking. The CCP staking in the different application scenarios can be handled by rich modules, such as time-to-depth conversion, 2D or 3D CCP stacking, and adaptive station or bin selection for CCP stacking profiles in a dense seismic array or a linear seismic array. As a Python module, functions in the Seispy can be called easily in python scripts for other purposes. The modular design allows new functionality to be added in a collaborative development environment. Seispy licensed under GPLv3 can be open accessed on [Github repository](https://github.com/xumi1993/seispy).

Expand Down
2 changes: 1 addition & 1 deletion source/usage/ccp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ The output structure would be saved as a ``.npy`` file, which can be read with `

.. note::

The layer_num was determined by field ``[depth]`` in parameter file.
The ``layer_num`` was determined by field ``[depth]`` in parameter file.

CCP Stack PRFs along a profile
================================
Expand Down
2 changes: 2 additions & 0 deletions source/usage/pickrf.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ When you have selected all PRFs, please click `finish` button to delete all 'poo
- Magnitude
- Gaussian factor

```{note}
This list file is **very important** for derived method such as H-k stacking and CCP stacking.
```

## Other functions

Expand Down

0 comments on commit 194c6d8

Please sign in to comment.