Skip to content

Commit 893fbfe

Browse files
jonschumacherjonschumacher
authored
Initial version of loading t-design (#1)
* Initial version of loading t-design * Bump version * Fix documentation build * Update TagBot workflow * Add Julia 1.8 to CI
1 parent 9d7e885 commit 893fbfe

File tree

11 files changed

+441
-0
lines changed

11 files changed

+441
-0
lines changed

‎.github/workflows/CI.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- main
6+
tags: '*'
7+
pull_request:
8+
concurrency:
9+
# Skip intermediate builds: always.
10+
# Cancel intermediate builds: only if it is a pull request build.
11+
group: ${{ github.workflow }}-${{ github.ref }}
12+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
13+
jobs:
14+
test:
15+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
16+
runs-on: ${{ matrix.os }}
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
version:
21+
- '1.7'
22+
- '1.8'
23+
- 'nightly'
24+
os:
25+
- ubuntu-latest
26+
- macOS-latest
27+
- windows-latest
28+
arch:
29+
- x64
30+
steps:
31+
- uses: actions/checkout@v2
32+
- uses: julia-actions/setup-julia@v1
33+
with:
34+
version: ${{ matrix.version }}
35+
arch: ${{ matrix.arch }}
36+
- uses: julia-actions/cache@v1
37+
- uses: julia-actions/julia-buildpkg@v1
38+
- uses: julia-actions/julia-runtest@v1
39+
- uses: julia-actions/julia-processcoverage@v1
40+
- uses: codecov/codecov-action@v2
41+
with:
42+
files: lcov.info
43+
docs:
44+
name: Documentation
45+
runs-on: ubuntu-latest
46+
steps:
47+
- uses: actions/checkout@v2
48+
- uses: julia-actions/setup-julia@v1
49+
with:
50+
version: '1'
51+
- run: |
52+
julia --project=docs -e '
53+
using Pkg
54+
Pkg.develop(PackageSpec(path=pwd()))
55+
Pkg.instantiate()'
56+
- run: |
57+
julia --project=docs -e '
58+
using Documenter
59+
using MPISphericalHarmonics
60+
DocMeta.setdocmeta!(MPISphericalHarmonics, :DocTestSetup, :(using MPISphericalHarmonics); recursive=true)
61+
doctest(MPISphericalHarmonics, manual=false)'
62+
- run: julia --project=docs docs/make.jl
63+
env:
64+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
65+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

‎.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/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: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Files generated by invoking Julia with --code-coverage
2+
*.jl.cov
3+
*.jl.*.cov
4+
5+
# Files generated by invoking Julia with --track-allocation
6+
*.jl.mem
7+
8+
# System-specific files and directories generated by the BinaryProvider and BinDeps packages
9+
# They contain absolute paths specific to the host computer, and so should not be committed
10+
deps/deps.jl
11+
deps/build.log
12+
deps/downloads/
13+
deps/usr/
14+
deps/src/
15+
16+
# Build artifacts for creating documentation generated by the Documenter package
17+
docs/build/
18+
docs/site/
19+
20+
# File generated by Pkg, the package manager, based on a corresponding Project.toml
21+
# It records a fixed state of all packages used by the project. As such, it should not be
22+
# committed for packages, but should be committed for applications that require a static
23+
# environment.
24+
Manifest.toml
25+
LocalPreferences.toml
26+
27+
*.h5
28+
*.hdf5
29+
*.mdf
30+
*.tar.gz
31+
32+
.vscode

‎Project.toml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name = "MPISphericalHarmonics"
2+
uuid = "2527f7a4-0af4-4016-a944-036fbac19de9"
3+
authors = ["Marija Boberg <[email protected]> and contributors"]
4+
version = "0.0.1"
5+
6+
[deps]
7+
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
8+
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
9+
MPIFiles = "371237a9-e6c1-5201-9adb-3d8cfa78fa9f"
10+
MPIMagneticFields = "f6dda52a-86e9-4b50-afb7-f39836a99446"
11+
SphericalHarmonicExpansions = "504afa71-bae7-47b4-8ec9-3851161806ac"
12+
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
13+
14+
[compat]
15+
DocStringExtensions = "0.8, 0.9"
16+
MPIFiles = "0.12"
17+
MPIMagneticFields = "0"
18+
SphericalHarmonicExpansions = "0.1"
19+
Unitful = "1.11, 1.12"
20+
julia = "1"
21+
22+
[extras]
23+
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
24+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
25+
26+
[targets]
27+
test = ["Aqua", "Test"]

‎README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# MPISphericalHarmonics
2+
3+
Julia package for handling measured data for spherical t-designs used in [Magnetic Particle Imaging](https://en.wikipedia.org/wiki/Magnetic_particle_imaging).
4+
5+
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://magneticparticleimaging.github.io/MPISphericalHarmonics.jl/dev/)
6+
[![Build status](https://github.com/MagneticParticleImaging/MPISphericalHarmonics.jl/workflows/CI/badge.svg)](https://github.com/MagneticParticleImaging/MPISphericalHarmonics.jl/actions)
7+
[![codecov.io](http://codecov.io/github/MagneticParticleImaging/MPISphericalHarmonics.jl/coverage.svg?branch=main)](http://codecov.io/github/MagneticParticleImaging/MPISphericalHarmonics.jl?branch=main)
8+
[![License](https://img.shields.io/github/license/MagneticParticleImaging/MPISphericalHarmonics.jl?color=green&style=flat)](https://github.com/MagneticParticleImaging/MPISphericalHarmonics.jl/blob/main/LICENSE)
9+
[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

‎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+
MPISphericalHarmonics = "2527f7a4-0af4-4016-a944-036fbac19de9"

‎docs/make.jl

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
using MPISphericalHarmonics
2+
using Documenter
3+
4+
DocMeta.setdocmeta!(MPISphericalHarmonics, :DocTestSetup, :(using MPISphericalHarmonics); recursive=true)
5+
6+
makedocs(;
7+
modules=[MPISphericalHarmonics],
8+
authors="Marija Boberg <[email protected]> and contributors",
9+
repo="https://github.com/MagneticParticleImaging/MPISphericalHarmonics.jl/blob/{commit}{path}#{line}",
10+
sitename="MPISphericalHarmonics.jl",
11+
format=Documenter.HTML(;
12+
prettyurls=get(ENV, "CI", "false") == "true",
13+
canonical="https://github.com/MagneticParticleImaging/MPISphericalHarmonics.jl",
14+
assets=String[],
15+
),
16+
pages=[
17+
"Home" => "index.md",
18+
],
19+
)
20+
21+
deploydocs(repo = "github.com/MagneticParticleImaging/MPISphericalHarmonics.jl.git",
22+
target = "build")

‎docs/src/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
```@meta
2+
CurrentModule = MPISphericalHarmonics
3+
```
4+
5+
# MPISphericalHarmonics
6+
7+
Documentation for [MPISphericalHarmonics](https://github.com/MagneticParticleImaging/MPISphericalHarmonics.jl).
8+
9+
```@index
10+
```
11+
12+
```@autodocs
13+
Modules = [MPISphericalHarmonics]
14+
```

0 commit comments

Comments
 (0)