docs up

.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+on:
+  - push
+  - pull_request
+env:
+  JULIA_NUM_THREADS: 2
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.9'
+          - '^1'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+          include-all-prereleases: true
+      - uses: actions/cache@v3
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - run: |
+          julia --project=@. -e '
+            using Pkg
+            Pkg.Registry.add(RegistrySpec(url = "https://github.com/RoyCCWang/RWPublicJuliaRegistry"))'
+
+        shell: bash
+        env:
+          DATADEPS_ALWAYS_ACCEPT: true
+      - uses: julia-actions/julia-buildpkg@latest
+        env:
+          DATADEPS_ALWAYS_ACCEPT: true
+      - uses: julia-actions/julia-runtest@latest
+        env:
+          DATADEPS_ALWAYS_ACCEPT: true
+      - uses: julia-actions/julia-processcoverage@v1
+        env:
+          DATADEPS_ALWAYS_ACCEPT: true
+      - uses: codecov/codecov-action@v3
+        with:
+          file: lcov.info
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - run: |
+          julia --project=docs -e '
+            import Pkg; Pkg.add("Documenter")
+            using Pkg
+            Pkg.Registry.add(RegistrySpec(url = "https://github.com/RoyCCWang/RWPublicJuliaRegistry"))
+            
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+        shell: bash
+        env:
+          DATADEPS_ALWAYS_ACCEPT: true
+      - run: |
+          julia --project=docs -e '
+            import Pkg; Pkg.add("Documenter")
+            using Documenter: doctest
+            using Pkg
+            Pkg.Registry.add(RegistrySpec(url = "https://github.com/RoyCCWang/RWPublicJuliaRegistry"))
+            
+            using MaternRegression
+            const GS = MaternRegression
+            doctest(MaternRegression)'
+        shell: bash
+        env:
+          DATADEPS_ALWAYS_ACCEPT: true
+      - run: julia --project=docs docs/make.jl 'using Pkg;
+            Pkg.Registry.add(RegistrySpec(url = "https://github.com/RoyCCWang/RWPublicJuliaRegistry"))'
+
+        shell: bash
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          DATADEPS_ALWAYS_ACCEPT: true

CITATION.cff

@@ -0,0 +1,10 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Wang"
+  given-names: "Roy Chih Chung"
+  orcid: "https://orcid.org/0000-0002-1391-4536"
+title: "RoyCCWang/MaternRegression.jl"
+version: 0.1.0
+date-released: 2024-04-06
+url: "https://github.com/RoyCCWang/MaternRegression.jl"

README.md

@@ -1 +1,8 @@
-# MaternRegression.jl
+# MaternRegression.jl
+This package performs univariate Gaussian process regression inference for in-fill problems with the Matern `3/2` covariance function.
+
+## Documentation
+The [documentation](https://royccwang.github.io/MaternRegression.jl/) has usage tutorials and API specifications.
+
+## Citation
+The companion publication for this package is under peer-review. For now, you can cite this repository and code via the *Cite This Repository* button on the GitHub webpage of this repository.

docs/make.jl

@@ -21,28 +21,28 @@ makedocs(
     ],
 )
 
-# # github.
-# makedocs(
-#     sitename="MaternRegression.jl",
-#     modules=[MaternRegression],
-#     format=Documenter.HTML(prettyurls = get(ENV, "CI", nothing)=="true"),
-#     pages = [
-#         "Overview" => "index.md",
-#         "Public API" => "api.md",
+# github.
+makedocs(
+    sitename="MaternRegression.jl",
+    modules=[MaternRegression],
+    format=Documenter.HTML(prettyurls = get(ENV, "CI", nothing)=="true"),
+    pages = [
+        "Overview" => "index.md",
+        "Public API" => "api.md",
 
-#         "Basic query" =>
-#         "generated/sde_gp_lit.md",
+        "Basic query" =>
+        "generated/sde_gp_lit.md",
 
-#         "Hyperparameter optimization" =>
-#         "generated/optim_lit.md",
+        "Hyperparameter optimization" =>
+        "generated/optim_lit.md",
 
-#         "Hyperparameter inference" =>
-#         "generated/mcmc_lit.md",
-#     ],
-# )
-# deploydocs(
-#     repo = "github.com/RoyCCWang/MaternRegression.jl",
-#     target = "build",
-#     branch = "gh-pages",
-#     versions = ["stable" => "v^", "v#.#" ],
-# )
+        "Hyperparameter inference" =>
+        "generated/mcmc_lit.md",
+    ],
+)
+deploydocs(
+    repo = "github.com/RoyCCWang/MaternRegression.jl",
+    target = "build",
+    branch = "gh-pages",
+    versions = ["stable" => "v^", "v#.#" ],
+)