Renaming PETSC.jl -> PetscCall.jl

Author: fverdugo

Project.toml

@@ -1,4 +1,4 @@
-name = "PETSC"
+name = "PetscCall"
 uuid = "1194c000-87c4-4102-b4a0-a6217ec4849e"
 authors = ["Francesc Verdugo <[email protected]> and contributors"]
 version = "0.1.0"

README.md

@@ -1,32 +1,32 @@
-# PETSC
+# PetscCall
 
 This package provides easy access to PETSc solvers in sequential and parallel Julia computations.
 
 
 | **Documentation** |
 |:------------ |
-| [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://fverdugo.github.io/PETSC.jl/stable/) |
-| [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://fverdugo.github.io/PETSC.jl/dev/) |
+| [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://fverdugo.github.io/PetscCall.jl/stable/) |
+| [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://fverdugo.github.io/PetscCall.jl/dev/) |
 |**Build Status** |
-[![Build Status](https://github.com/fverdugo/PETSC.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/fverdugo/PETSC.jl/actions/workflows/CI.yml?query=branch%3Amain) |
+[![Build Status](https://github.com/fverdugo/PetscCall.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/fverdugo/PetscCall.jl/actions/workflows/CI.yml?query=branch%3Amain) |
 |**Coverage** |
-| [![Coverage](https://codecov.io/gh/fverdugo/PETSC.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/fverdugo/PETSC.jl) |
+| [![Coverage](https://codecov.io/gh/fverdugo/PetscCall.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/fverdugo/PetscCall.jl) |
 
 ## Documentation
 
-- [**STABLE**](https://fverdugo.github.io/PETSC.jl/stable) — **Documentation for the most recently tagged version.**
-- [**LATEST**](https://fverdugo.github.io/PETSC.jl/dev) — *Documentation for the in-development version.*
+- [**STABLE**](https://fverdugo.github.io/PetscCall.jl/stable) — **Documentation for the most recently tagged version.**
+- [**LATEST**](https://fverdugo.github.io/PetscCall.jl/dev) — *Documentation for the in-development version.*
 
 ## Help and discussion
 
-- You can open a new discussion to ask questions [here](https://github.com/fverdugo/PETSC.jl/discussions).
-- If you have found a bug, open an issue [here](https://github.com/fverdugo/PETSC.jl/issues). Do not forget to include a (minimal) reproducer.
+- You can open a new discussion to ask questions [here](https://github.com/fverdugo/PetscCall.jl/discussions).
+- If you have found a bug, open an issue [here](https://github.com/fverdugo/PetscCall.jl/issues). Do not forget to include a (minimal) reproducer.
 
 ## Contributing
 
 This package is under active development and there are several ways to contribute:
 
 - by enhancing the documentation (e.g., fixing typos, enhancing doc strings, adding examples).
-- by addressing one of the [issues waiting for help](https://github.com/fverdugo/PETSC.jl/labels/help%20wanted).
+- by addressing one of the [issues waiting for help](https://github.com/fverdugo/PetscCall.jl/labels/help%20wanted).
 - by adding more tests to increase the code coverage.
-- by extending the current functionality. In this case, open a discussion [here](https://github.com/fverdugo/PETSC.jl/discussions) to coordinate with the package maintainers before proposing significant changes.
+- by extending the current functionality. In this case, open a discussion [here](https://github.com/fverdugo/PetscCall.jl/discussions) to coordinate with the package maintainers before proposing significant changes.

docs/Project.toml

@@ -1,4 +1,4 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-PETSC = "1194c000-87c4-4102-b4a0-a6217ec4849e"
+PetscCall = "1194c000-87c4-4102-b4a0-a6217ec4849e"
 PartitionedArrays = "5a9dfac6-5c52-46f7-8278-5e2210713be9"

docs/make.jl

@@ -1,14 +1,14 @@
-using PETSC
+using PetscCall
 using Documenter
 
-DocMeta.setdocmeta!(PETSC, :DocTestSetup, :(using PETSC); recursive=true)
+DocMeta.setdocmeta!(PetscCall, :DocTestSetup, :(using PetscCall); recursive=true)
 
 makedocs(;
-    modules=[PETSC],
-    sitename="PETSC.jl",
+    modules=[PetscCall],
+    sitename="PetscCall.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://fverdugo.github.io/PETSC.jl",
+        canonical="https://fverdugo.github.io/PetscCall.jl",
         edit_link="main",
         assets=String[],
     ),
@@ -22,6 +22,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/fverdugo/PETSC.jl",
+    repo="github.com/fverdugo/PetscCall.jl",
     devbranch="main",
 )

docs/src/advanced.md

@@ -2,7 +2,7 @@
 # Advanced API
 
 ```@autodocs
-Modules = [PETSC]
+Modules = [PetscCall]
 Pages = ["api.jl"]
 ```
 

docs/src/config.md

@@ -6,29 +6,29 @@ This packages uses Preferences.jl for its configuration.
 
 To use the petsc installation provided by BinaryBuilder.jl run these commands:
 
-    using PETSC
-    PETSC.use_petsc_jll()
+    using PetscCall
+    PetscCall.use_petsc_jll()
     # Restart Julia now
 
 You can also specify the integer and scalar types to use:
 
-    using PETSC
-    PETSC.use_petsc_jll(PetscInt=Int32,PetscScalar=Float32)
+    using PetscCall
+    PetscCall.use_petsc_jll(PetscInt=Int32,PetscScalar=Float32)
     # Restart Julia now
 
 ## Use a system binary
 
 To use PETSc installed in your system:
 
-    using PETSC
-    PETSC.use_system_petsc()
+    using PetscCall
+    PetscCall.use_system_petsc()
     # Restart Julia now
 
 This will look in `LD_LIBRARY_PATH` for a file called `libpetsc.so`.
 
 You can also provide the full path to `libpetsc.so`.
 
-    using PETSC
-    PETSC.use_system_petsc(;libpetsc_path=path/to/libpetsc.so)
+    using PetscCall
+    PetscCall.use_system_petsc(;libpetsc_path=path/to/libpetsc.so)
     # Restart Julia now
 

docs/src/index.md

@@ -1,10 +1,10 @@
 ```@meta
-CurrentModule = PETSC
+CurrentModule = PetscCall
 ```
 
-# PETSC
+# PetscCall
 
-Documentation for [PETSC](https://github.com/fverdugo/PETSC.jl).
+Documentation for [PetscCall](https://github.com/fverdugo/PetscCall.jl).
 
 ## What
 

docs/src/reference.md

@@ -4,21 +4,21 @@
 ## Configuration
 
 ```@autodocs
-Modules = [PETSC]
+Modules = [PetscCall]
 Pages = ["preferences_tail.jl"]
 ```
 
 ## Environment
 
 ```@autodocs
-Modules = [PETSC]
+Modules = [PetscCall]
 Pages = ["environment.jl"]
 ```
 
 ## Linear solvers (KSP)
 
 ```@autodocs
-Modules = [PETSC]
+Modules = [PetscCall]
 Pages = ["ksp.jl"]
 ```
 

docs/src/usage.md

@@ -5,7 +5,7 @@
 
     using SparseArrays
     using Test
-    using PETSC
+    using PetscCall
     using LinearAlgebra
 
     # Create a spare matrix and a vector in Julia
@@ -18,41 +18,41 @@
     x = ones(m)
     b = A*x
 
-    # PETSC options
+    # PetscCall options
     options = "-ksp_type gmres -ksp_monitor -pc_type ilu"
-    PETSC.init(args=split(options))
+    PetscCall.init(args=split(options))
 
     # Say, we want to solve A*x=b
     x2 = similar(x); x2 .= 0
-    setup = PETSC.ksp_setup(x2,A,b)
-    results = PETSC.ksp_solve!(x2,setup,b)
+    setup = PetscCall.ksp_setup(x2,A,b)
+    results = PetscCall.ksp_solve!(x2,setup,b)
     @test x ≈ x2
 
     # Info about the solution process
     @show results
 
     # Now with the same matrix, but a different rhs
     b = 2*b
-    results = PETSC.ksp_solve!(x2,setup,b)
+    results = PetscCall.ksp_solve!(x2,setup,b)
     @test 2*x ≈ x2
 
     # Now with a different matrix, but reusing as much as possible
     # from the previous solve.
     A = 2*A
-    PETSC.ksp_setup!(setup,A)
-    results = PETSC.ksp_solve!(x2,setup,b)
+    PetscCall.ksp_setup!(setup,A)
+    results = PetscCall.ksp_solve!(x2,setup,b)
     @test x ≈ x2
 
     # The user needs to explicitly destroy
     # the setup object. This cannot be hidden in
     # Julia finalizers since destructors in petsc are
     # collective operations (in parallel runs).
     # Julia finalizers do not guarantee this.
-    PETSC.ksp_finalize!(setup)
+    PetscCall.ksp_finalize!(setup)
 
     # The setup object cannot be used anymore.
     # This now would be provably a code dump:
-    # PETSC.ksp_solve!(x2,setup,b)
+    # PetscCall.ksp_solve!(x2,setup,b)
 
 ## Parallel example
 
@@ -61,7 +61,7 @@ First write the parallel code in a function in a file `demo.jl`.
     # File demo.jl
     using SparseArrays
     using Test
-    using PETSC
+    using PetscCall
     using PartitionedArrays
 
     function ksp_tests(distribute)
@@ -94,22 +94,22 @@ First write the parallel code in a function in a file `demo.jl`.
 
         # Now solve the system with petsc
         options = "-ksp_type gmres -pc_type jacobi -ksp_rtol 1.0e-12"
-        PETSC.init(;args = split(options))
+        PetscCall.init(;args = split(options))
 
         x2 = similar(x); x2 .= 0
-        setup = PETSC.ksp_setup(x2,A,b)
-        results = PETSC.ksp_solve!(x2,setup,b)
+        setup = PetscCall.ksp_setup(x2,A,b)
+        results = PetscCall.ksp_solve!(x2,setup,b)
         @test x ≈ x2
 
         b = 2*b
-        results = PETSC.ksp_solve!(x2,setup,b)
+        results = PetscCall.ksp_solve!(x2,setup,b)
         @test 2*x ≈ x2
 
-        PETSC.ksp_setup!(setup,A)
-        results = PETSC.ksp_solve!(x2,setup,b)
+        PetscCall.ksp_setup!(setup,A)
+        results = PetscCall.ksp_solve!(x2,setup,b)
         @test 2*x ≈ x2
 
-        PETSC.ksp_finalize!(setup)
+        PetscCall.ksp_finalize!(setup)
     end
 
 Then, test your code with the debug back-end of PartitionedArrays.jl

src/PETSC.jl renamed to src/PetscCall.jl

@@ -1,4 +1,4 @@
-module PETSC
+module PetscCall
 
 using Preferences
 using Libdl

src/api.jl

@@ -45,11 +45,11 @@ macro wrapper(fn,rt,argts,args,url)
   end
   if isempty(rstrip(url))
     str = """
-        PETSC.$(fn.value)$(sargs)
+        PetscCall.$(fn.value)$(sargs)
     """
   else
     str = """
-        PETSC.$(fn.value)$(sargs)
+        PetscCall.$(fn.value)$(sargs)
 
     See [PETSc manual]($url).
     """

src/environment.jl

@@ -1,6 +1,6 @@
 
 """
-    PETSC.init(:kwargs...)
+    PetscCall.init(:kwargs...)
 
 Document me!
 """
@@ -12,14 +12,14 @@ function init(;args=String[],file="",help="",finalize_atexit=true)
         atexit(finalize)
     end
     finalize()
-    new_args = ["PETSC"]
+    new_args = ["PetscCall"]
     append!(new_args,args)
     @check_error_code PetscInitializeNoPointers(length(new_args),new_args,file,help)
     nothing
 end
 
 """
-    PETSC.initialized()
+    PetscCall.initialized()
 
 Document me!
 """
@@ -30,7 +30,7 @@ function initialized()
 end
 
 """
-    PETSC.finalize()
+    PetscCall.finalize()
 
 Document me!
 """
@@ -42,7 +42,7 @@ function finalize()
 end
 
 """
-    PETSC.with(f;kwargs...)
+    PetscCall.with(f;kwargs...)
 
 Document me!
 """