Skip to content

Commit

Permalink
deploy5
Browse files Browse the repository at this point in the history
  • Loading branch information
mongibellili committed Jul 1, 2024
1 parent 50e918c commit 1e66e56
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/build/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.2","generation_timestamp":"2024-07-01T10:45:54","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.9.2","generation_timestamp":"2024-07-01T13:11:24","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion docs/build/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Quantized State System Solver</title><meta name="title" content="Home · Quantized State System Solver"/><meta property="og:title" content="Home · Quantized State System Solver"/><meta property="twitter:title" content="Home · Quantized State System Solver"/><meta name="description" content="Documentation for Quantized State System Solver."/><meta property="og:description" content="Documentation for Quantized State System Solver."/><meta property="twitter:description" content="Documentation for Quantized State System Solver."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Quantized State System Solver</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/mongibellili/QuantizedSystemSolver" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/mongibellili/QuantizedSystemSolver/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantizedSystemSolver.testFunc-Tuple{Any}" href="#QuantizedSystemSolver.testFunc-Tuple{Any}"><code>QuantizedSystemSolver.testFunc</code></a><span class="docstring-category">Method</span></header><section><div><p>testFunc(x)</p><p>creates a problem from the user code</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mongibellili/QuantizedSystemSolver/blob/b461c4fe741ec48918e3710f46bf6f763c6060b7/src/QuantizedSystemSolver.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantizedSystemSolver.solve-Union{Tuple{Sparsity}, Tuple{CS}, Tuple{D}, Tuple{Z}, Tuple{T}, Tuple{PRTYPE}, Tuple{NLODEProblem{PRTYPE, T, Z, D, CS}, Tuple{Float64, Float64}}} where {PRTYPE, T, Z, D, CS, Sparsity}" href="#QuantizedSystemSolver.solve-Union{Tuple{Sparsity}, Tuple{CS}, Tuple{D}, Tuple{Z}, Tuple{T}, Tuple{PRTYPE}, Tuple{NLODEProblem{PRTYPE, T, Z, D, CS}, Tuple{Float64, Float64}}} where {PRTYPE, T, Z, D, CS, Sparsity}"><code>QuantizedSystemSolver.solve</code></a><span class="docstring-category">Method</span></header><section><div><p>solve(prob::NLODEProblem{PRTYPE,T,Z,D,CS},tspan::Tuple{Float64, Float64};sparsity::Val{Sparsity}=Val(false)::Float64,saveat=1e-9::Float64::Float64,abstol=1e-4::Float64,reltol=1e-3::Float64,maxErr=Inf::Float64) where {PRTYPE,T,Z,D,CS,Sparsity} </p><p>dispatches on a specific integrator based on the algorithm provided. After the simulation, the solution is returned as a Solution object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mongibellili/QuantizedSystemSolver/blob/b461c4fe741ec48918e3710f46bf6f763c6060b7/src/Interface/QSS_Solve.jl#L4-L9">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 1 July 2024 10:45">Monday 1 July 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Quantized State System Solver</title><meta name="title" content="Home · Quantized State System Solver"/><meta property="og:title" content="Home · Quantized State System Solver"/><meta property="twitter:title" content="Home · Quantized State System Solver"/><meta name="description" content="Documentation for Quantized State System Solver."/><meta property="og:description" content="Documentation for Quantized State System Solver."/><meta property="twitter:description" content="Documentation for Quantized State System Solver."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Quantized State System Solver</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/mongibellili/QuantizedSystemSolver" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/mongibellili/QuantizedSystemSolver/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantizedSystemSolver.solve-Union{Tuple{Sparsity}, Tuple{CS}, Tuple{D}, Tuple{Z}, Tuple{T}, Tuple{PRTYPE}, Tuple{NLODEProblem{PRTYPE, T, Z, D, CS}, Tuple{Float64, Float64}}} where {PRTYPE, T, Z, D, CS, Sparsity}" href="#QuantizedSystemSolver.solve-Union{Tuple{Sparsity}, Tuple{CS}, Tuple{D}, Tuple{Z}, Tuple{T}, Tuple{PRTYPE}, Tuple{NLODEProblem{PRTYPE, T, Z, D, CS}, Tuple{Float64, Float64}}} where {PRTYPE, T, Z, D, CS, Sparsity}"><code>QuantizedSystemSolver.solve</code></a><span class="docstring-category">Method</span></header><section><div><p>solve(prob::NLODEProblem{PRTYPE,T,Z,D,CS},tspan::Tuple{Float64, Float64};sparsity::Val{Sparsity}=Val(false)::Float64,saveat=1e-9::Float64::Float64,abstol=1e-4::Float64,reltol=1e-3::Float64,maxErr=Inf::Float64) where {PRTYPE,T,Z,D,CS,Sparsity} </p><p>dispatches on a specific integrator based on the algorithm provided. After the simulation, the solution is returned as a Solution object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/mongibellili/QuantizedSystemSolver/blob/50e918cd79cfc8c2eeb77c5bafd629503f6c9c53/src/Interface/QSS_Solve.jl#L4-L9">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 1 July 2024 13:11">Monday 1 July 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
6 changes: 3 additions & 3 deletions docs/build/objects.inv
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
# Project: Quantized State System Solver
# Version: 1.0.0-DEV
# The remainder of this file is compressed using zlib.
x��RQO�0~߯�Dy+f#�ޔn��(
>�� Sڅu.�w -ÌK�|�}��z���~�TŢ�/�D��U�7�\�)���uɳs�gOM�U��E�
�D�w�/d� צC���]^�R�[F�G�c�c�c�s�/]�p�H�q-� +��)J`Tu�D���XҶ-|l�F8f#�:�7��PmE���^� o�5%��zA��!%�N�l���t>��C��e�� Xߑ~씌8!�+����xb�G���(���`�y�~���馴��HOߪ
x��RQK�0~߯8p}K�,ba�6>�VS�[���&�M�9��͚62P|�}_�rw�����|���k�{U�l�ʝ.�lzK[g�j��-�.���c��bJ|`�h��J�t�ڃ�;uS�cG�
s�:�;�9��do�څ�Ot��j+�<c� P��
}{C` ]���k�Ki\��.V��`��s� ��48�bDI-G#a�D=%���Sl�<]��-{�BnaȻ�ϰ%+�AL�-���g�'�0_�m���
2 changes: 1 addition & 1 deletion docs/build/search_index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 38 additions & 8 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,13 +1,43 @@
using Documenter
using QuantizedSystemSolver
makedocs(sitename="Quantized State System Solver",
modules=[QuantizedSystemSolver],
pages=[
"Home" => "index.md"
])

# Set up deployment environment variables
#const DOCUMENTER_KEY = ENV["DOCUMENTER_KEY"] # Load the private key from environment variables

# Function to deploy documentation

makedocs(
sitename = "Quantized State System Solver",
modules = [QuantizedSystemSolver],
pages = [
"Home" => "index.md"
]
)

deploydocs(
repo = "github.com/mongibellili/mongibellili.github.io.git",
target = "gh-pages", # Ensure this branch exists or is created
branch = "gh-pages"
repo = "git@github.com:mongibellili/mongibellili.github.io.git",
branch = "gh-pages",
# deploy_key = ENV["DOCUMENTER_KEY"] # Provide the deployment key explicitly
)
# Perform deployment using SSH key authentication
# run(`git config --global user.email "[email protected]"`)
# run(`git config --global user.name "mongibellili"`)


# cd("C:/Users/belli/Documents/mongibellili.github.io")
# run(`pwd`)
# cd("C:/Users/belli/.julia/dev/QuantizedSystemSolver/docs/build/")
# run(`pwd`)
# Copy the generated documentation files to the repository
# run(`cp -r "C:/Users/belli/.julia/dev/QuantizedSystemSolver/docs/build/*"`) # Adjust the path based on your actual build directory

# Add, commit, and push the changes
# run(`git add .`)
# run(`git commit -m "Deploy documentation"`)
# run(`git push origin gh-pages`) # Push to the gh-pages branch (or your designated branch)





# Main execution block
3 changes: 0 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Functions

```@docs
testFunc(x)
```


```@docs
Expand Down
8 changes: 1 addition & 7 deletions src/QuantizedSystemSolver.jl
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,7 @@ import Base: sqrt, exp, log, sin, cos, sincos, tan,

export savedNLODEContProblem,savedNLODEDiscProblem,EventDependencyStruct

export testFunc

"""testFunc(x)
creates a problem from the user code
"""
testFunc(x) = 2x + 1



#include section of ts subcomponent
Expand Down

0 comments on commit 1e66e56

Please sign in to comment.