Skip to content

Commit 8d3db97

Browse files
committed
update readme
1 parent c69bba9 commit 8d3db97

File tree

5 files changed

+11
-98
lines changed

5 files changed

+11
-98
lines changed

.appveyor.yml

Lines changed: 0 additions & 42 deletions
This file was deleted.

.travis.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Benoit Pasquier
3+
Copyright (c) 2018–2024 Benoit Pasquier
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,17 @@
11
# Inpaintings.jl
22

33
<p>
4-
<a href="https://briochemc.github.io/Inpaintings.jl/dev">
5-
<img src=https://img.shields.io/badge/docs-dev-blue.svg>
4+
<a href="https://github.com/briochemc/Inpaintings.jl/actions">
5+
<img src="https://img.shields.io/github/actions/workflow/status/briochemc/Inpaintings.jl/mac.yml?label=OSX&logo=Apple&logoColor=white&style=flat-square">
66
</a>
7-
<a href="https://briochemc.github.io/Inpaintings.jl/stable">
8-
<img src=https://img.shields.io/badge/docs-stable-blue.svg>
7+
<a href="https://github.com/briochemc/Inpaintings.jl/actions">
8+
<img src="https://img.shields.io/github/actions/workflow/status/briochemc/Inpaintings.jl/linux.yml?label=Linux&logo=Linux&logoColor=white&style=flat-square">
99
</a>
10-
<a href="https://ci.appveyor.com/project/briochemc/Inpaintings-jl">
11-
<img src=https://ci.appveyor.com/api/projects/status/udbwakr621jbyvj1?svg=true>
12-
</a>
13-
<a href="https://travis-ci.com/briochemc/Inpaintings.jl">
14-
<img alt="Build Status" src="https://travis-ci.com/briochemc/Inpaintings.jl.svg?branch=master">
15-
</a>
16-
<a href='https://coveralls.io/github/briochemc/Inpaintings.jl?branch=master'>
17-
<img src='https://coveralls.io/repos/github/briochemc/Inpaintings.jl/badge.svg?branch=master' alt='Coverage Status' />
10+
<a href="https://github.com/briochemc/Inpaintings.jl/actions">
11+
<img src="https://img.shields.io/github/actions/workflow/status/briochemc/Inpaintings.jl/windows.yml?label=Windows&logo=Windows&logoColor=white&style=flat-square">
1812
</a>
1913
<a href="https://codecov.io/gh/briochemc/Inpaintings.jl">
20-
<img src="https://codecov.io/gh/briochemc/Inpaintings.jl/branch/master/graph/badge.svg" />
14+
<img src="https://img.shields.io/codecov/c/github/briochemc/Inpaintings.jl/master?label=Codecov&logo=codecov&logoColor=white&style=flat-square">
2115
</a>
2216
<a href="https://github.com/briochemc/Inpaintings.jl/blob/master/LICENSE">
2317
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg">
@@ -31,7 +25,7 @@ This package provides a Julia version of MATLAB's `inpaint_nans` function (origi
3125
Simply put, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) provides a simple `inpaint` function, which takes an array `A` as input and inpaints its `missing` values by solving a simple *n*-dimensional PDE.
3226
The `inpaint` function can also be used to inpaint `NaN`s or any other values, thanks to the syntax described below and in the [documentation](https://briochemc.github.io/Inpaintings.jl/stable).
3327

34-
## Usage:
28+
## Usage:
3529

3630
Like every Julia package you must first add it via `]add Inpaintings`.
3731
And every time you want to use [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl), you must start with
@@ -43,7 +37,7 @@ In order to `inpaint` an array `A`'s `missing` values, simply apply `inpaint` to
4337
```julia
4438
julia> inpaint(A) # will inpaint missing values
4539
```
46-
The array to be inpainted can be a vector, a matrix, or even an *n*-dimensional array.
40+
The array to be inpainted can be a vector, a matrix, or even an *n*-dimensional array.
4741

4842
If your array `A` has some `NaN` values and is filled with floats otherwise, then
4943
```julia
@@ -63,7 +57,7 @@ julia> inpaint(f, A)
6357
In this case, the values of `A` for which `f` returns `true` will be inpainted.
6458
(For example, `f` can be, e.g., `ismissing` or `isnan`, but it can also be `x -> x < 0`.)
6559

66-
Finally, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) provides a syntax to allow some dimensions to be assumed cyclic:
60+
Finally, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) provides a syntax to allow some dimensions to be assumed cyclic:
6761
```julia
6862
julia> inpaint(A, cycledims=[1]) # will inpaint A with dimension 1 as cyclic
6963
```

REQUIRE

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)