add apps and change readme

FrameFunVC · Apr 25, 2019 · a4d9a55 · a4d9a55
1 parent 5c7b93a
commit a4d9a55
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3,003 deletions.
diff --git a/README.md b/README.md
@@ -3,220 +3,37 @@
  [![Coverage Status](https://coveralls.io/repos/github/vincentcp/CardinalBSplines.jl/badge.svg?branch=master)](https://coveralls.io/github/vincentcp/CardinalBSplines.jl?branch=master)
  # CardinalBSplines
 
-A Julia module for evaluating cardinal B splines and L2 inner products over cardinal B splines
+**A Julia package for B-splines operations**
 
+| **Documentation** | **Build Status** | **Coverage** |
+|-------------------|------------------|--------------|
+| [![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://vincentcp.github.io/CardinalBSplines.jl/stable)
+  [![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://vincentcp.github.io/CardinalBSplines.jl/dev)
+| [![Build Status](https://travis-ci.org/vincentcp/CardinalBSplines.jl.png)](https://travis-ci.org/vincentcp/CardinalBSplines.jl)
+  [![Build status](https://ci.appveyor.com/api/projects/status/gh4ka7m9a7qekqu8?svg=true)](https://ci.appveyor.com/project/PieterjanRobbe/multilevelestimators-jl)
+| [![Coverage](https://codecov.io/gh/vincentcp/CardinalBSplines.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/vincentcp/CardinalBSplines.jl)
+  [![Coverage Status](https://coveralls.io/repos/github/vincentcp/CardinalBSplines.jl/badge.svg)](https://coveralls.io/github/vincentcp/CardinalBSplines.jl) |
 
 
-```julia
-using CardinalBSplines
-using QuadGK
-using Plots
-```
+Installation instructions and full functionality can be found in the [documentation](https://vincentcp.github.io/CardinalBSplines.jl/dev)
 
-`BSpline`
 
 
-```julia
-t = LinRange(-1,11,500)
-plot(legend=false)
-[plot!(t,BSpline(degree).(t)) for degree in 0:10]
-plot!()
-```
 
 
 
 
-![svg](README_files/README_3_0.svg)
-
-
 
-`PeriodicBSpline`
-
-
-```julia
-t = LinRange(-1,11,500)
-plot(legend=false)
-[plot!(t,PeriodicBSpline(degree,4).(t)) for degree in 0:6]
-plot!()
-```
+# Examples  
 
+#### The B-splines of order 0 to 10,
 
+![svg](README_files/README_3_0.svg)
 
+#### The periodic, centered B-splines of order 0 to 10 with period 4.
 
 ![svg](README_files/README_5_0.svg)
 
-
-
-`PeriodicCenteredBSpline`
-
-
-```julia
-t = LinRange(-4,4,500)
-plot(legend=false)
-[plot!(t,PeriodicCenteredBSpline(degree, 4).(t)) for degree in 0:6]
-plot!()
-```
-
-
-
-
-![svg](README_files/README_7_0.svg)
-
-
-
-`BSplineDiff`
-
-
-```julia
-t = LinRange(-1,11,500)
-plot(legend=false)
-[plot!(t,BSplineDiff(4,diff).(t)) for diff in 0:4]
-plot!()
-```
-
-
-
-
-![svg](README_files/README_9_0.svg)
-
-
-
-`PeriodicBSplineDiff`
-
-
-```julia
-t = LinRange(-1,7,500)
-plot(legend=false)
-[plot!(t,PeriodicBSplineDiff(4,3,diff).(t)) for diff in 0:4]
-plot!()
-```
-
-
-
+#### The 0th to 4th derivative of the periodic B-spline of order 4 with period 3.
 
 ![svg](README_files/README_11_0.svg)
-
-
-
-
-```julia
-
-```
-
-
-```julia
-
-```
-
-squared_spline_integral(N::Int)
-
-
-```julia
-squared_integrals = [squared_spline_integral(N) for N in 1:10]
-```
-
-
-
-
-    10-element Array{Rational{BigInt},1}:
-                      2//3                  
-                     11//20                 
-                    151//315                
-                  15619//36288              
-                 655177//1663200            
-               27085381//74131200           
-             2330931341//6810804000         
-            12157712239//37638881280        
-         37307713155613//121645100408832    
-     339781108897078469//1161157776629760000
-
-
-
-
-```julia
-squared_integrals_test = [QuadGK.quadgk(x->CardinalBSplines.evaluate_Bspline(Val{N}(),x,Float64)^2,LinRange(0,11,12)...)[1] for N in 1:10]
-```
-
-
-
-
-    10-element Array{Float64,1}:
-     0.6666666666666667
-     0.5499999999999999
-     0.4793650793650795
-     0.43041776895943445
-     0.3939255651755637
-     0.3653708694854521
-     0.3422402613553404
-     0.32300939415699864
-     0.30669310173798253
-     0.2926226872314349
-
-
-
-
-```julia
-@assert squared_integrals ≈ squared_integrals_test
-```
-
-shifted_spline_integral(m::Int,t::Int)
-
-
-```julia
-shifted_integrals = [shifted_spline_integral(N, t, BigFloat) for N in 1:10, t in 0:9]
-```
-
-
-
-
-    10×10 Array{BigFloat,2}:
-     0.666667  0.166667  0.0         0.0          …  0.0          0.0        
-     0.55      0.216667  0.00833333  0.0             0.0          0.0        
-     0.479365  0.23631   0.0238095   0.000198413     0.0          0.0        
-     0.430418  0.243149  0.0402557   0.00138338      0.0          0.0        
-     0.393926  0.24396   0.055202    0.00382388      0.0          0.0        
-     0.365371  0.241788  0.067975    0.00731224   …  0.0          0.0        
-     0.34224   0.238123  0.0785953   0.0115023       0.0          0.0        
-     0.323009  0.233737  0.0873116   0.0160739       2.81146e-15  0.0        
-     0.306693  0.229046  0.0944193   0.0207811       4.30982e-12  8.22064e-18
-     0.292623  0.22428   0.100194    0.025452        2.03837e-10  4.1047e-14
-
-
-
-
-```julia
-shifted_integrals_test = [QuadGK.quadgk(x->CardinalBSplines.evaluate_Bspline(Val{N}(),x-t,Float64)*
-        CardinalBSplines.evaluate_Bspline(Val{N}(),x,Float64),LinRange(0,11,12)...)[1] for N in 1:10, t in 0:9]
-```
-
-
-
-
-    10×10 Array{Float64,2}:
-     0.666667  0.166667  0.0         0.0          …  0.0          0.0        
-     0.55      0.216667  0.00833333  0.0             0.0          0.0        
-     0.479365  0.23631   0.0238095   0.000198413     0.0          0.0        
-     0.430418  0.243149  0.0402557   0.00138338      0.0          0.0        
-     0.393926  0.24396   0.055202    0.00382388      0.0          0.0        
-     0.365371  0.241788  0.067975    0.00731224   …  0.0          0.0        
-     0.34224   0.238123  0.0785953   0.0115023       0.0          0.0        
-     0.323009  0.233737  0.0873116   0.0160739       2.81146e-15  0.0        
-     0.306693  0.229046  0.0944193   0.0207811       4.30982e-12  8.22064e-18
-     0.292623  0.22428   0.100194    0.025452        2.03837e-10  4.1047e-14
-
-
-
-
-```julia
-@assert shifted_integrals ≈ shifted_integrals_test
-```
-
-
-```julia
-
-```
-
-
-```julia
-
-```
diff --git a/appveyor.yml b/appveyor.yml
@@ -0,0 +1,42 @@
+environment:
+  matrix:
+  - julia_version: 1
+  - julia_version: nightly
+
+platform:
+  - x86 # 32-bit
+  - x64 # 64-bit
+
+# # Uncomment the following lines to allow failures on nightly julia
+# # (tests will run but not make your overall status red)
+matrix:
+   allow_failures:
+   - julia_version: nightly
+
+branches:
+  only:
+    - master
+    - /release-.*/
+
+notifications:
+  - provider: Email
+    on_build_success: false
+    on_build_failure: false
+    on_build_status_changed: false
+
+install:
+  - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
+
+build_script:
+  - echo "%JL_BUILD_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
+
+test_script:
+  - echo "%JL_TEST_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
+
+# # Uncomment to support code coverage upload. Should only be enabled for packages
+# # which would have coverage gaps without running on Windows
+# on_success:
+#   - echo "%JL_CODECOV_SCRIPT%"
+#   - C:\julia\bin\julia -e "%JL_CODECOV_SCRIPT%"
diff --git a/coverage/coverage.jl b/coverage/coverage.jl
@@ -6,5 +6,5 @@ using Coverage
 
 cd(joinpath(dirname(@__FILE__), "..")) do
     Coveralls.submit(process_folder())
-    # Codecov.submit(process_folder())
+    Codecov.submit(process_folder())
 end