Skip to content

Commit c0788b3

Browse files
danlooodanlooo
authored
Init julia package (#7)
* Files generated by PkgTemplates PkgTemplates version: 0.7.52 * Add files from open-call-use-case-pangeo-julia * Add funding note * Add citation to README * Update README.md * Add dependencies * Fix dependencies and compat close #1 #2 #3 #4 #5 #6 * Fix julia compat * Remove arch x86 * Update documentation CI * Add debug shell to Documenter CI * Remove debug shell to Documenter CI * Fix github org * Fix documentation links in README.md
1 parent ddc0a85 commit c0788b3

File tree

17 files changed

+735
-0
lines changed

17 files changed

+735
-0
lines changed

‎.github/dependabot.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/" # Location of package manifests
6+
schedule:
7+
interval: "weekly"

‎.github/workflows/CI.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- main
6+
tags: ["*"]
7+
pull_request:
8+
workflow_dispatch:
9+
concurrency:
10+
# Skip intermediate builds: always.
11+
# Cancel intermediate builds: only if it is a pull request build.
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
14+
jobs:
15+
test:
16+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
17+
runs-on: ${{ matrix.os }}
18+
timeout-minutes: 60
19+
permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
20+
actions: write
21+
contents: read
22+
strategy:
23+
fail-fast: false
24+
matrix:
25+
version:
26+
- "1"
27+
- "lts"
28+
os:
29+
- ubuntu-latest
30+
arch:
31+
- x64
32+
steps:
33+
- uses: actions/checkout@v4
34+
- uses: julia-actions/setup-julia@v2
35+
with:
36+
version: ${{ matrix.version }}
37+
arch: ${{ matrix.arch }}
38+
- uses: julia-actions/cache@v2
39+
- uses: julia-actions/julia-buildpkg@v1
40+
- uses: julia-actions/julia-runtest@v1
41+
- uses: julia-actions/julia-processcoverage@v1
42+
- uses: codecov/codecov-action@v4
43+
with:
44+
files: lcov.info
45+
token: ${{ secrets.CODECOV_TOKEN }}
46+
fail_ci_if_error: false

‎.github/workflows/CompatHelper.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: CompatHelper
2+
on:
3+
schedule:
4+
- cron: 0 0 * * *
5+
workflow_dispatch:
6+
jobs:
7+
CompatHelper:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Pkg.add("CompatHelper")
11+
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
12+
- name: CompatHelper.main()
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
16+
run: julia -e 'using CompatHelper; CompatHelper.main()'

‎.github/workflows/Documenter.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Documenter
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches:
10+
- main
11+
tags: ["*"]
12+
pull_request:
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
18+
permissions:
19+
contents: write
20+
pages: write
21+
id-token: write
22+
statuses: write
23+
24+
# Cancel previous runs if a new one is triggered (by push on PR)
25+
concurrency:
26+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
27+
cancel-in-progress: true
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-20.04
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
- name: Setup Julia
37+
uses: julia-actions/setup-julia@v2
38+
- name: Pull Julia cache
39+
uses: julia-actions/cache@v2
40+
- name: Install documentation dependencies
41+
run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
42+
- name: Install custom documentation dependencies
43+
run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()'
44+
#- name: Creating new mds from src
45+
- name: Build and deploy
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
48+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
49+
GKSwstype: "100"
50+
JULIA_DEBUG: "Documenter"
51+
DATADEPS_ALWAYS_ACCEPT: true
52+
run: |
53+
DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ --color=yes docs/make.jl

‎.github/workflows/TagBot.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: TagBot
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
7+
inputs:
8+
lookback:
9+
default: "3"
10+
permissions:
11+
actions: read
12+
checks: read
13+
contents: write
14+
deployments: read
15+
issues: read
16+
discussions: read
17+
packages: read
18+
pages: read
19+
pull-requests: read
20+
repository-projects: read
21+
security-events: read
22+
statuses: read
23+
jobs:
24+
TagBot:
25+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: JuliaRegistries/TagBot@v1
29+
with:
30+
token: ${{ secrets.GITHUB_TOKEN }}
31+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.jl.*.cov
2+
*.jl.cov
3+
*.jl.mem
4+
/docs/Manifest.toml
5+
/docs/build/
6+
Manifest.toml

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Daniel Loos <dloos@bgc-jena.mpg.de> and contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Project.toml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name = "RQADeforestation"
2+
uuid = "3f1d9318-18cc-4ffd-9937-04025ce33b74"
3+
authors = ["Felix Cremer <felix.cremer@bgc-jena.mpg.de>, Daniel Loos <dloos@bgc-jena.mpg.de> and contributors"]
4+
version = "1.0.0-DEV"
5+
6+
[deps]
7+
ArchGDAL = "c9ce4bd3-c3d5-55b8-8973-c0e20141b8c3"
8+
ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
9+
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
10+
ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
11+
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
12+
DimensionalData = "0703355e-b756-11e9-17c0-8b28908087d0"
13+
DiskArrayEngine = "2d4b2e14-ccd6-4284-b8b0-2378ace7c126"
14+
DiskArrayTools = "fcd2136c-9f69-4db6-97e5-f31981721d63"
15+
DiskArrays = "3c3547ce-8d99-4f5e-a174-61eb10b00ae3"
16+
Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
17+
Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
18+
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
19+
Extents = "411431e0-e8b7-467b-b5e0-f676ba4f2910"
20+
FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
21+
GDAL = "add2ef01-049f-52c4-9ee2-e494f65e021a"
22+
GeoFormatTypes = "68eda718-8dee-11e9-39e7-89f7f65f511f"
23+
Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
24+
KML = "1284bf3a-1e3d-4f4e-a7a9-b9d235a28f35"
25+
LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
26+
Missings = "e1d29d7a-bbdc-5cf2-9ac0-f12de2c33e28"
27+
NetCDF = "30363a11-5582-574a-97bb-aa9a979735b9"
28+
Proj = "c94c279d-25a6-4763-9509-64d165bea63e"
29+
Rasters = "a3a2b9e3-a471-40c9-b274-f788e487c689"
30+
RecurrenceAnalysis = "639c3291-70d9-5ea2-8c5b-839eba1ee399"
31+
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
32+
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
33+
TimeseriesSurrogates = "c804724b-8c18-5caa-8579-6025a0767c70"
34+
UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
35+
YAXArrayBase = "90b8fcef-0c2d-428d-9c56-5f86629e9d14"
36+
YAXArrays = "c21b50f5-aa40-41ea-b809-c0f5e47bfa5c"
37+
Zarr = "0a941bbe-ad1d-11e8-39d9-ab76183a1d99"
38+
39+
[compat]
40+
julia = "1.10"
41+
YAXArrayBase = "=0.6"
42+
Glob = "1"
43+
NetCDF="0.12"
44+
Zarr = "0.9"
45+
ArchGDAL = "0.10"
46+
YAXArrays = "0.5"
47+
48+
[extras]
49+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
50+
51+
[targets]
52+
test = ["Test"]

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# RQADeforestation
2+
3+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://earthyscience.github.io/RQADeforestation.jl/stable/)
4+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://earthyscience.github.io/RQADeforestation.jl/dev/)
5+
[![Build Status](https://github.com/EarthyScience/RQADeforestation.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/EarthyScience/RQADeforestation.jl/actions/workflows/CI.yml?query=branch%3Amain)
6+
[![Coverage](https://codecov.io/gh/EarthyScience/RQADeforestation.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/EarthyScience/RQADeforestation.jl)
7+
8+
This is the Julia package developed within the [FAIRSenDD project](https://github.com/EarthyScience/FAIRSenDD).
9+
10+
## Citation
11+
12+
F. Cremer, M. Urbazaev, J. Cortés, J. Truckenbrodt, C. Schmullius and C. Thiel, "Potential of Recurrence Metrics from Sentinel-1 Time Series for Deforestation Mapping," in IEEE Journal of Selected Topics in Applied Earth Observations and Remote Sensing, vol. 13, pp. 5233-5240, 2020, doi: [10.1109/JSTARS.2020.3019333](https://dx.doi.org/10.1109/JSTARS.2020.3019333).
13+
14+
## Funding
15+
16+
<img src="https://raw.githubusercontent.com/EarthyScience/FAIRSenDD/refs/heads/main/assets/ESA_logo.svg" align="left" height="50px"/>
17+
<img src="https://raw.githubusercontent.com/EarthyScience/FAIRSenDD/refs/heads/main/assets/ESA_NoR_logo.svg" align="left" height="50px" style="filter: contrast(0);"/>
18+
19+
This project was funded by the European Space Agency in the Science Result Long-Term Availability & Reusability Demonstrator Initiative.
20+
In addition, this project was supported by the ESA Network of Resources.

‎docs/Project.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
RQADeforestation = "3f1d9318-18cc-4ffd-9937-04025ce33b74"

0 commit comments

Comments
 (0)