Skip to content

Commit de831c4

Browse files
author
Documenter.jl
committed
build based on 566114a 
0 parents  commit de831c4

File tree

786 files changed

+4906663
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

786 files changed

+4906663
-0
lines changed

‎.github/workflows/CI.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: CI
2+
on:
3+
push:
4+
paths-ignore:
5+
- '*/*.md'
6+
- 'docs/**'
7+
pull_request:
8+
paths-ignore:
9+
- '*/*.md'
10+
- 'docs/**'
11+
12+
jobs:
13+
test:
14+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
15+
runs-on: ${{ matrix.os }}
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
version:
20+
- '1.6'
21+
- 'nightly'
22+
os:
23+
- ubuntu-latest
24+
- windows-latest
25+
- macOS-latest
26+
arch:
27+
- x64
28+
steps:
29+
- uses: actions/checkout@v2
30+
- uses: julia-actions/setup-julia@v1
31+
with:
32+
version: ${{ matrix.version }}
33+
arch: ${{ matrix.arch }}
34+
- uses: actions/cache@v1
35+
env:
36+
cache-name: cache-artifacts
37+
with:
38+
path: ~/.julia/artifacts
39+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
40+
restore-keys: |
41+
${{ runner.os }}-test-${{ env.cache-name }}-
42+
${{ runner.os }}-test-
43+
${{ runner.os }}-
44+
- uses: julia-actions/julia-buildpkg@v1
45+
- uses: julia-actions/julia-runtest@v1
46+
- uses: julia-actions/julia-processcoverage@v1
47+
- uses: codecov/codecov-action@v1
48+
with:
49+
file: lcov.info
50+
# - uses: julia-actions/julia-uploadcoveralls@v1
51+
# env:
52+
# COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}

‎.github/workflows/CompatHelper.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CompatHelper
2+
on:
3+
schedule:
4+
- cron: 0 0 * * 0 # weekly
5+
workflow_dispatch:
6+
7+
jobs:
8+
CompatHelper:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Pkg.add("CompatHelper")
12+
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
13+
- name: CompatHelper.main()
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
16+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} # need ssh
17+
run: julia -e 'using CompatHelper; CompatHelper.main()'
18+
19+
# based on:
20+
# https://github.com/JuliaRegistries/CompatHelper.jl

‎.github/workflows/Documentation.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- 'main'
8+
- 'release-'
9+
tags: '*'
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- uses: julia-actions/setup-julia@latest
17+
with:
18+
version: '1.6'
19+
- name: Cache artifacts
20+
uses: actions/cache@v1
21+
env:
22+
cache-name: cache-artifacts
23+
with:
24+
path: ~/.julia/artifacts
25+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
26+
restore-keys: |
27+
${{ runner.os }}-test-${{ env.cache-name }}-
28+
${{ runner.os }}-test-
29+
${{ runner.os }}-
30+
- name: Install dependencies
31+
run: |
32+
julia --project=docs/ -e '
33+
ENV["JULIA_PKG_SERVER"] = ""
34+
using Pkg
35+
Pkg.develop(PackageSpec(path=pwd()))
36+
Pkg.instantiate()'
37+
- name: BuildAndDeploy
38+
env:
39+
# https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#Authentication:-GITHUB_TOKEN
40+
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
ssh: ${{ secrets.DOCUMENTER_KEY }}
42+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
43+
run: julia --project=docs/ docs/make.jl
44+

‎.github/workflows/TagBot.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: TagBot
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
7+
jobs:
8+
TagBot:
9+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: JuliaRegistries/TagBot@v1
13+
with:
14+
token: ${{ secrets.GITHUB_TOKEN }}
15+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.gitignore

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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+
26+
# other
27+
.DS_Store
28+
.*.*.swp
29+
.benchmarkci

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Jeff Fessler <[email protected]> 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

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name = "ImagePhantoms"
2+
uuid = "71a99df6-f52c-4da1-bd2a-69d6f37f3252"
3+
authors = ["Jeff Fessler <[email protected]> and contributors"]
4+
version = "0.0.1"
5+
6+
[deps]
7+
SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
8+
9+
[compat]
10+
SpecialFunctions = "1.5"
11+
julia = "1.6"

‎README.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# ImagePhantoms.jl
2+
3+
https://github.com/JuliaImageRecon/ImagePhantoms.jl (_WIP!_)
4+
5+
[![action status][action-img]][action-url]
6+
[![pkgeval status][pkgeval-img]][pkgeval-url]
7+
[![codecov][codecov-img]][codecov-url]
8+
[![license][license-img]][license-url]
9+
[![docs-stable][docs-stable-img]][docs-stable-url]
10+
[![docs-dev][docs-dev-img]][docs-dev-url]
11+
[![code-style][code-blue-img]][code-blue-url]
12+
13+
This Julia language repo
14+
provides tools for working with software-defined image phantoms
15+
like the Shepp-Logan phantom.
16+
17+
For explanations see the documentation
18+
using the blue "docs" links above.
19+
20+
21+
### Getting started
22+
23+
```julia
24+
using Pkg
25+
Pkg.add("ImagePhantoms")
26+
```
27+
28+
29+
### Example
30+
31+
```julia
32+
using ImagePhantoms
33+
using ImageGeoms # not required, but helpful
34+
todo
35+
```
36+
37+
### Documentation
38+
39+
For more examples with graphics,
40+
see the
41+
[documentation][docs-stable-url].
42+
43+
44+
### Dependents
45+
46+
* [Michigan Image Reconstruction Toolbox (MIRT)](https://github.com/JeffFessler/MIRT.jl)
47+
* [Sinograms.jl](https://github.com/todo/Sinograms.jl)
48+
* [SPECTrecon.jl](https://github.com/todo/SPECTrecon.jl)
49+
* See [juliahub](https://juliahub.com/ui/Search?q=ImagePhantoms&type=packages)
50+
51+
52+
### Related packages
53+
54+
* [AxisArrays](https://github.com/JuliaArrays/AxisArrays.jl)
55+
* [ImageGeoms](https://github.com/JuliaImageRecon/ImageGeoms.jl)
56+
* [JuliaImages/Images.jl](https://github.com/JuliaImages/Images.jl) `shepp_logan`
57+
* [TestImages.jl](https://github.com/JuliaImages/TestImages.jl): `shepp_logan`
58+
59+
60+
### Compatibility
61+
62+
Tested with Julia ≥ 1.6.
63+
64+
<!-- URLs -->
65+
[action-img]: https://github.com/JuliaImageRecon/ImagePhantoms.jl/workflows/CI/badge.svg
66+
[action-url]: https://github.com/JuliaImageRecon/ImagePhantoms.jl/actions
67+
[build-img]: https://github.com/JuliaImageRecon/ImagePhantoms.jl/workflows/CI/badge.svg?branch=main
68+
[build-url]: https://github.com/JuliaImageRecon/ImagePhantoms.jl/actions?query=workflow%3ACI+branch%3Amain
69+
[pkgeval-img]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/I/ImagePhantoms.svg
70+
[pkgeval-url]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/I/ImagePhantoms.html
71+
[code-blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
72+
[code-blue-url]: https://github.com/invenia/BlueStyle
73+
[codecov-img]: https://codecov.io/github/JuliaImageRecon/ImagePhantoms.jl/coverage.svg?branch=main
74+
[codecov-url]: https://codecov.io/github/JuliaImageRecon/ImagePhantoms.jl?branch=main
75+
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
76+
[docs-stable-url]: https://JuliaImageRecon.github.io/ImagePhantoms.jl/stable
77+
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
78+
[docs-dev-url]: https://JuliaImageRecon.github.io/ImagePhantoms.jl/dev
79+
[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat
80+
[license-url]: LICENSE

‎dev/.documenter-siteinfo.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-07T12:51:02","documenter_version":"1.8.0"}}

‎dev/assets/custom.css

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.docs-sourcelink {
2+
opacity:1 !important;
3+
}

0 commit comments

Comments
 (0)