Skip to content

Commit

Permalink
Revert "change name"
Browse files Browse the repository at this point in the history
This reverts commit 933dc53.
  • Loading branch information
HoBeZwe committed Jan 4, 2023
1 parent e3e4bbc commit 899b38e
Show file tree
Hide file tree
Showing 17 changed files with 46 additions and 46 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ jobs:
- run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using Nurbs
DocMeta.setdocmeta!(Nurbs, :DocTestSetup, :(using Nurbs); recursive=true)
doctest(Nurbs)'
using NURBS
DocMeta.setdocmeta!(NURBS, :DocTestSetup, :(using NURBS); recursive=true)
doctest(NURBS)'
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ authors:
- family-names: Hofmann
given-names: Bernd
orcid: https://orcid.org/0000-0003-1435-6203
title: "Nurbs"
url: "https://github.com/HoBeZwe/Nurbs"
title: "NURBS"
url: "https://github.com/HoBeZwe/NURBS"
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name = "Nurbs"
name = "NURBS"
uuid = "dde13934-061e-461b-aa91-2c0fad390a0d"
authors = ["Bernd Hofmann <[email protected]> and contributors"]
version = "0.3.0"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Please cite this package following the information on [Zenodo](https://zenodo.or

## Documentation

Here you can find the [documentation](https://hobezwe.github.io/Nurbs.jl/dev/).
Here you can find the [documentation](https://hobezwe.github.io/NURBS.jl/dev/).
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Nurbs = "dde13934-061e-461b-aa91-2c0fad390a0d"
NURBS = "dde13934-061e-461b-aa91-2c0fad390a0d"
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Expand Down
10 changes: 5 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
using Nurbs
using NURBS
using Documenter

DocMeta.setdocmeta!(Nurbs, :DocTestSetup, :(using Nurbs); recursive=true)
DocMeta.setdocmeta!(NURBS, :DocTestSetup, :(using NURBS); recursive=true)

makedocs(;
modules=[NURBS],
authors="Bernd Hofmann <[email protected]> and contributors",
sitename="Nurbs.jl",
sitename="NURBS.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true", canonical="https://HoBeZwe.github.io/Nurbs.jl", edit_link="main", assets=String[]
prettyurls=get(ENV, "CI", "false") == "true", canonical="https://HoBeZwe.github.io/NURBS.jl", edit_link="main", assets=String[]
),
pages=[
"Introduction" => "index.md",
Expand All @@ -20,4 +20,4 @@ makedocs(;
],
)

deploydocs(; repo="github.com/HoBeZwe/Nurbs.jl", devbranch="main")
deploydocs(; repo="github.com/HoBeZwe/NURBS.jl", devbranch="main")
2 changes: 1 addition & 1 deletion docs/src/apiref.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
# API Reference

```@autodocs
Modules = [Nurbs]
Modules = [NURBS]
```
16 changes: 8 additions & 8 deletions docs/src/assets/logo_Scat_README.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions docs/src/assets/logo_Scat_READMEwhite.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/basis.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The considered B-spline and NURBS basis functions are defined by initializing co
NURBS and B-spline bases are defined by initializing a [`Bspline`](@ref Bspline) or a [`NURB`](@ref NURB) structure, respectively.

```@example basis
using Nurbs # hide
using NURBS # hide
# --- parameters
b = 6 # number of basis functions
p = 2 # degree of NURBS
Expand Down
12 changes: 6 additions & 6 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In order to contribute to this package directly create a pull request against th
For a consistent style the [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) package is used which enforces the style defined in the *.JuliaFormatter.toml* file. To follow this style simply run
```julia
using JuliaFormatter
format(pkgdir(Nurbs))
format(pkgdir(NURBS))
```

!!! note
Expand All @@ -33,19 +33,19 @@ Add documentation for any changes or new features following the style of the exi
Write tests for your code changes and verify that no errors occur, e.g., by running
```julia
using Pkg
Pkg.test("Nurbs")
Pkg.test("NURBS")
```

For more detailed information on which parts are tested the coverage can be evaluated on your local machine, e.g., by
```julia
using Pkg
Pkg.test("Nurbs"; coverage=true, julia_args=`--threads 4`)
Pkg.test("NURBS"; coverage=true, julia_args=`--threads 4`)

# determine coverage
using Coverage
src_folder = pkgdir(Nurbs) * "/src"
src_folder = pkgdir(NURBS) * "/src"
coverage = process_folder(src_folder)
LCOV.writefile("path-to-folder-you-like" * "Nurbs.lcov.info", coverage)
LCOV.writefile("path-to-folder-you-like" * "NURBS.lcov.info", coverage)

clean_folder(src_folder) # delete .cov files

Expand All @@ -54,4 +54,4 @@ covered_lines, total_lines = get_summary(coverage)
@info "Current coverage:\n$covered_lines of $total_lines lines ($(round(Int, covered_lines / total_lines * 100)) %)"
```

In Visual Studio Code the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) plugin can be used to visualize the tested lines of the code by inserting the path of the *Nurbs.lcov.info* file in the settings.
In Visual Studio Code the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) plugin can be used to visualize the tested lines of the code by inserting the path of the *SphericalScattering.lcov.info* file in the settings.
2 changes: 1 addition & 1 deletion docs/src/curves.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Both are defined by initializing corresponding structures.
NURBS and B-spline curves are defined by initializing a [`BsplineCurve`](@ref BsplineCurve) or a [`NURBScurve`](@ref NURBScurve) structure, respectively.

```@example curves
using Nurbs # hide
using NURBS # hide
# --- parameters
kVec = Float64[0, 0, 0, 0, 1, 2, 3, 4, 5, 6, 6, 6, 6] # knot vector
kVec ./= maximum(kVec) # normalize it
Expand Down
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Nurbs.jl
# NURBS.jl

This package provides functionality to define and evaluate B-spline and NURBS (non-uniform rational B-spline) basis functions, their derivatives, as well as curves and surfaces based on both considered basis functions.

Expand Down Expand Up @@ -32,10 +32,10 @@ Basically, chapters 2-4 of [[1]](@ref refs) are implemented so far (adapted to 1
---
## Installation

Installing Nurbs is done by entering the package manager (enter `]` at the julia REPL) and issuing:
Installing NURBS is done by entering the package manager (enter `]` at the julia REPL) and issuing:

```
pkg> add Nurbs
pkg> add NURBS
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/src/surfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Both are defined by initializing corresponding structures.
NURBS and B-spline surfaces are defined by initializing a [`BsplineSurface`](@ref BsplineSurface) or a [`NURBSsurface`](@ref NURBSsurface) structure, respectively.

```@example surfaces
using Nurbs # hide
using NURBS # hide
using StaticArrays
# --- parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/src/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To read multipatch files as defined and provided by the [nurbs Octave implementa
Also note, that the Octave package so far provides more functionality.

```@example utils
using Nurbs # hide
using NURBS # hide
Patches = readMultipatch("assets/sphere.dat")
using PlotlyJS
Expand Down
2 changes: 1 addition & 1 deletion src/Nurbs.jl → src/NURBS.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module Nurbs
module NURBS

# -------- used packages
using LinearAlgebra
Expand Down
4 changes: 2 additions & 2 deletions test/runtests.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using Nurbs
using NURBS
using Test

using JuliaFormatter
Expand Down Expand Up @@ -27,7 +27,7 @@ using PlotlyJS
end

@testset "Test formatting of files" begin
pkgpath = pkgdir(Nurbs) # path of this package including name
pkgpath = pkgdir(NURBS) # path of this package including name
@test format(pkgpath, overwrite=false) # check whether files are formatted according to the .JuliaFormatter.toml
end
end

2 comments on commit 899b38e

@HoBeZwe
Copy link
Owner Author

@HoBeZwe HoBeZwe commented on 899b38e Jan 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/74950

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 899b38e3273791ed3ff9ceeac44bd3839de57ed8
git push origin v0.3.0

Also, note the warning: This looks like a new registration that registers version 0.3.0.
Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.