Skip to content

Commit

Permalink
init repo
Browse files Browse the repository at this point in the history
  • Loading branch information
kongdd committed Jul 11, 2024
0 parents commit 517cc99
Show file tree
Hide file tree
Showing 20 changed files with 1,138 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# https://github.com/Alexander-Barth/NCDatasets.jl/blob/master/.github/workflows/ci.yml
name: CI
on:
- push
- pull_request
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
version:
# - '1.3'
- '1'
# - 'nightly'
os:
- ubuntu-latest
- macOS-latest
# - windows-latest
arch:
- x64
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/cache@v1
- uses: julia-actions/julia-buildpkg@latest
- run: |
git config --global user.name Tester
git config --global user.email [email protected]
- uses: julia-actions/julia-runtest@latest
continue-on-error: ${{ matrix.version == 'nightly' }}

- uses: julia-actions/julia-processcoverage@v1
- uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: lcov.info
24 changes: 24 additions & 0 deletions .github/workflows/CompatHelper.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: CompatHelper

on:
schedule:
- cron: '15 23 */4 * *'

jobs:
CompatHelper:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: [1.2.0]
julia-arch: [x86]
os: [ubuntu-latest]
steps:
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}
- name: Pkg.add("CompatHelper")
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
- name: CompatHelper.main()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: julia -e 'using CompatHelper; CompatHelper.main()'
20 changes: 20 additions & 0 deletions .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Documenter
on:
push:
branches: [master, main]
tags: [v*]
pull_request:
branches: [master, main]
jobs:
Documenter:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
env:
RASTERDATASOURCES_PATH: ".."
GKSwstype: "100"
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
18 changes: 18 additions & 0 deletions .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# https://github.com/JuliaRegistries/TagBot
name: TagBot
on:
issue_comment:
types:
- created
workflow_dispatch:
jobs:
TagBot:
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
# Edit the following line to reflect the actual name of the GitHub Secret containing your private key
ssh: ${{ secrets.DOCUMENTER_KEY }}
# ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Manifest.toml
*debug*
.vscode
docs/build
13 changes: 13 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name = "ClimateStats"
uuid = "f2027f19-6765-4257-993d-235c5fe36d77"
authors = ["Dongdong Kong <[email protected]>"]
version = "0.1.0"

[deps]
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
Ipaper = "e58298cb-69f7-4186-aecd-5834b6793426"
NaNStatistics = "b946abbf-3ea7-4610-9019-9858bfdeaf2d"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
6 changes: 6 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[deps]
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
34 changes: 34 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
using Documenter, ClimateStats
CI = get(ENV, "CI", nothing) == "true"

# Logging.disable_logging(Logging.Warn)

# Make the docs, without running the tests again
# We need to explicitly add all the extensions here
makedocs(
modules=[
ClimateStats
# Base.get_extension(Ipaper, :IpaperSlopeExt)
],
format=Documenter.HTML(
prettyurls=CI,
),
pages=[
"Introduction" => "index.md"
"R Base" => "RBase.md"
"Statistics" => "Statistics.md"
"Slope" => "Slope.md"
"Climate" => "Climate.md"
"Parallel" => "Parallel.md"
],
sitename="ClimateStats.jl",
warnonly=true,
clean=false,
)

# Enable logging to console again
# Logging.disable_logging(Logging.BelowMinLevel)

deploydocs(
repo="github.com/jl-pkgs/ClimateStats.jl.git",
)
36 changes: 36 additions & 0 deletions docs/src/Climate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
```@contents
Pages = ["index.md"]
Depth = 3
```

## Thresholds

```@docs
cal_anomaly_quantile
cal_anomaly_clim
cal_threshold
```

```@docs
_cal_anomaly_3d
```

```@docs
cal_mTRS_base
cal_mTRS_full
cal_climatology_base
cal_climatology_full
```


```@docs
Ipaper.cal_mTRS_base!
Ipaper.cal_mTRS_base3!
```


```@docs
cal_yearly_Tair
cal_warming_level
```
15 changes: 15 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ClimateStats in Julia (R base for Julia)

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://jl-pkgs.github.io/ClimateStats.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jl-pkgs.github.io/ClimateStats.jl/dev)
[![CI](https://github.com/jl-pkgs/ClimateStats.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/jl-pkgs/ClimateStats.jl/actions/workflows/CI.yml)
[![Codecov](https://codecov.io/gh/jl-pkgs/ClimateStats.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jl-pkgs/ClimateStats.jl)

> Dongdong Kong
## Installation

```
using Pkg
Pkg.add(url="https://github.com/jl-pkgs/ClimateStats.jl")
```
27 changes: 27 additions & 0 deletions src/ClimateStats.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
module ClimateStats

using Ipaper
using Printf
using Dates
using NaNStatistics

using Reexport
@reexport using DocStringExtensions: TYPEDSIGNATURES, METHODLIST

include("base.jl")
include("threshold.jl")
include("climatology.jl")
include("anomaly.jl")
include("warming_level.jl")

# export cal_mTRS_base, cal_mTRS_season, cal_mTRS_full
export format_md
export cal_climatology_base, cal_climatology_full, cal_climatology_full,
_cal_anomaly,
cal_anomaly_quantile, cal_anomaly_clim, cal_threshold,
cal_warming_level, cal_yearly_Tair


export filter_mds

end # module ClimateStats
Loading

0 comments on commit 517cc99

Please sign in to comment.