Skip to content

Commit 4901810

Browse files
authored
Merge pull request #1 from kolosovpetro/updates
Updates## [1.0.0] - 2025-02-21 ### Changed - Configure workspace - Recompile document - Update CI/CD - Initial version of manuscript - Update readme
2 parents 1196baf + ed5e739 commit 4901810

40 files changed

+16930
-2179
lines changed

.github/workflows/build-and-deploy-pdf.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ jobs:
1515
uses: kolosovpetro/github-latex-template/.github/workflows/build-and-deploy-pdf-template.yml@main
1616
secrets: inherit
1717
with:
18-
file_name: 'GithubLatexTemplate'
18+
file_name: 'AnEfficientMethodOfSplineApproximation'
1919
runs_on: 'ubuntu-latest'
2020
workflow_name: 'Build and Deploy PDF'
2121
build_assets_path: |
22-
src/GithubLatexTemplate.tex
23-
src/GithubLatexTemplate.bbl
24-
src/GithubLatexTemplate.bib
22+
src/AnEfficientMethodOfSplineApproximation.tex
23+
src/AnEfficientMethodOfSplineApproximation.bbl
24+
src/AnEfficientMethodOfSplineApproximation.bib
2525
src/sections
2626
working_directory_for_latex: 'src'

.github/workflows/build-pdf.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ jobs:
2020
build-pdf:
2121
uses: kolosovpetro/github-latex-template/.github/workflows/build-pdf-template.yml@main
2222
with:
23-
file_name: 'GithubLatexTemplate'
23+
file_name: 'AnEfficientMethodOfSplineApproximation'
2424
runs_on: 'ubuntu-latest'
2525
workflow_name: 'Build PDF'
2626
build_assets_path: |
27-
src/GithubLatexTemplate.tex
28-
src/GithubLatexTemplate.bbl
29-
src/GithubLatexTemplate.bib
27+
src/AnEfficientMethodOfSplineApproximation.tex
28+
src/AnEfficientMethodOfSplineApproximation.bbl
29+
src/AnEfficientMethodOfSplineApproximation.bib
3030
src/sections
3131
working_directory_for_latex: 'src'

CHANGELOG.md

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
77

8-
## [1.3.1] - 2025-01-15
8+
## [1.0.0] - 2025-02-21
99

1010
### Changed
1111

12-
- Update initializer script
13-
- Move images folder
14-
- Add figures folder
15-
- Add default keywords
16-
- Update README
17-
- Update bibliography
18-
19-
20-
## [1.3.0] - 2024-10-06
21-
22-
### Changed
23-
24-
- Implement powershell build script that can be run from any location
25-
- Implement powershell build script that searches for latex file in its PSRoot folder
26-
- Implement powershell script that renames main latex and bibtex files to match repo root directory name
27-
- Update README with new build instructions
28-
29-
## [1.2.0] - 2024-09-25
30-
31-
### Changed
32-
33-
- Implement latex build template (GitHub Actions)
34-
- Implement latex deploy template (GitHub Actions)
35-
36-
## [1.1.9] - 2024-07-03
37-
38-
### Changed
39-
40-
- Hotfix update GitHub Actions GitVersion
41-
42-
## [1.1.8] - 2024-07-03
43-
44-
### Changed
45-
46-
- Changelog added
47-
- README updated
48-
- Theorem environments update
49-
- Footnote added
50-
- Bump GitHub Actions version
51-
- Hotfix update GitHub Actions GitVersion
52-
53-
## [1.1.7] - 2024-01-31
54-
55-
### Changed
56-
57-
- Initial release before change log introduced.
12+
- Configure workspace
13+
- Recompile document
14+
- Update CI/CD
15+
- Initial version of manuscript
16+
- Update readme

README.md

Lines changed: 11 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,15 @@
1-
# GitHub LaTeX Template
1+
# An efficient method of spline approximation for power function
22

3-
[![Build PDF](https://github.com/kolosovpetro/github-latex-template/actions/workflows/build-pdf.yml/badge.svg)](https://github.com/kolosovpetro/github-latex-template/actions/workflows/build.yml/badge.svg)
4-
[![Build and Deploy PDF](https://github.com/kolosovpetro/github-latex-template/actions/workflows/build-and-deploy-pdf.yml/badge.svg)](https://github.com/kolosovpetro/github-latex-template/actions/workflows/build-and-deploy.yml/badge.svg)
3+
Let $P(m, X, N)$ be an $m$-degree polynomials in $X\in\mathbb{R}$
4+
having fixed non-negative integers $m$ and $N$.
5+
Essentially, the polynomial $P(m, X, N)$ is a result of rearrangement inside Faulhaber's formula
6+
in context of Knuth's work Johann Faulhaber and sums of powers.
57

6-
LaTeX template for GitHub including general CI/CD actions and Mathematica templates.
8+
In this manuscript we discuss approximation properties of polynomial $P(m,X,N)$.
9+
In particular, the polynomial $P(m,X,N)$ approximates odd power function $X^{2m+1}$ in certain neighborhood
10+
of fixed non-negative integer $N$ with percentage error lesser than $1\%$.
711

8-
- https://dev.azure.com/PetroKolosovProjects/github-latex-template
12+
By increasing the value of $N$ the length of convergence interval with odd-power $X^{2m+1}$ increasing as well.
913

10-
## GitHub Actions used
11-
12-
- https://github.com/actions/checkout
13-
- https://github.com/GitTools/actions/blob/main/docs/examples/github/gitversion/index.md
14-
- https://github.com/xu-cheng/latex-action
15-
- https://github.com/actions/upload-artifact
16-
17-
## Build and run using PowerShell (Windows)
18-
19-
- Install `MikTeX`: https://miktex.org/download
20-
- Update `MikTeX`
21-
- Install `SumatraPDF` viewer: https://www.sumatrapdfreader.org/download-free-pdf-viewer
22-
- `Rename-Tex-Files.ps1` renames main LaTeX and BibTeX files to match the repository root directory name
23-
- `Build-Latex.ps1`
24-
25-
## Build and run in Intellij IDEA (Windows)
26-
27-
- Install `MikTeX`: https://miktex.org/download
28-
- Update `MikTeX`
29-
- Install `SumatraPDF` viewer: https://www.sumatrapdfreader.org/download-free-pdf-viewer
30-
- Path to SumatraPDF: `C:\Program Files\SumatraPDF`
31-
- Install `Intellij IDEA Ultimate`: https://www.jetbrains.com/idea/download/#section=windows
32-
- Activate `Intellij IDEA Ultimate`
33-
- Install `TeXiFy IDEA` plugin: https://plugins.jetbrains.com/plugin/9473-texify-idea
34-
- Clone this repository locally: `https://github.com/kolosovpetro/github-latex-template.git`
35-
- Open `github-latex-template` folder in `Intellij IDEA Ultimate` and configure as follows
36-
- LaTeX Configuration
37-
![LaTeX Configuration](./src/sections/images/latex_configuration.png "LaTeX Configuration")
38-
- BibTeX Configuration
39-
![BibTeX Configuration](./src/sections/images/bibtex_configuration.png "BibTeX Configuration")
40-
- Configure Inverse Search in `Intellij IDEA` for SumatraPDF: `Tools -> LaTeX -> Configure Inverse Search`
41-
- Compile document using `Shift + F10`
42-
43-
## How to use Mathematica package
44-
45-
- Open the package file `GithubLatexTemplateMathematicaPackage.m` in Wolfram Mathematica, I use version 13.0
46-
- Execute the package using `Shift+Enter`
47-
- Open the notebook file `GithubLatexTemplateMathematicaNotebook.nb`
48-
- Execute the line: `Needs["GithubLatexTemplateMathematicaPackage"]`
49-
- Continue your work as desired
50-
51-
## Configure CI / CD
52-
53-
- Update root file name in `build-pdf.yml` and `build-and-deploy-pdf.yml`
54-
- Set repository secrets
55-
- `GH_ACCESS_TOKEN`: Generate GitHub Personal access token at
56-
`Settings -> Developer Settings -> Personal access tokens -> Generate mew token`
57-
58-
## Actions and their trigger policy
59-
60-
- `build-pdf.yml` builds project using `TeXLive`. Triggered on `pull_request`, `push` to `develop` branch
61-
- `build-and-deploy-pdf.yml` builds project using `TeXLive` and deploys to `GitHub Pages`. Triggered on `push` to `main`
62-
branch
63-
64-
## Template example
65-
66-
Compiled document looks like as follows
67-
68-
<p align="center">
69-
<img src="src/sections/images/template_example.png" alt="template_example"/>
70-
<img src="src/sections/images/template_example2.png" alt="template_example"/>
71-
</p>
14+
Furthermore, this approximation technique is generalized for arbitrary non-negative exponent power function $X^j$
15+
by using splines.

azure-pipelines/azure-pipelines-linux-mshosted.yml

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

mathematica/GithubLatexTemplate.m

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

0 commit comments

Comments
 (0)