build based on 030d1a5

drbergman · Jan 23, 2025 · f6f30b4 · f6f30b4
1 parent 868718f
commit f6f30b4
Show file tree

Hide file tree

Showing 31 changed files with 51 additions and 51 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-23T18:04:12","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-23T21:04:10","documenter_version":"1.8.0"}}
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/lib/VCTAnalysis/index.html b/dev/lib/VCTAnalysis/index.html
diff --git a/dev/lib/VCTClasses/index.html b/dev/lib/VCTClasses/index.html
diff --git a/dev/lib/VCTCompilation/index.html b/dev/lib/VCTCompilation/index.html
diff --git a/dev/lib/VCTConfiguration/index.html b/dev/lib/VCTConfiguration/index.html
diff --git a/dev/lib/VCTCreation/index.html b/dev/lib/VCTCreation/index.html
@@ -2,4 +2,4 @@
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>VCTCreation · pcvct</title><meta name="title" content="VCTCreation · pcvct"/><meta property="og:title" content="VCTCreation · pcvct"/><meta property="twitter:title" content="VCTCreation · pcvct"/><meta name="description" content="Documentation for pcvct."/><meta property="og:description" content="Documentation for pcvct."/><meta property="twitter:description" content="Documentation for pcvct."/><meta property="og:url" content="https://drbergman.github.io/pcvct/lib/VCTCreation/"/><meta property="twitter:url" content="https://drbergman.github.io/pcvct/lib/VCTCreation/"/><link rel="canonical" href="https://drbergman.github.io/pcvct/lib/VCTCreation/"/><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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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="../../">pcvct</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><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../../man/best_practices/">Best practices</a></li><li><a class="tocitem" href="../../man/getting_started/">Getting started</a></li><li><a class="tocitem" href="../../man/covariations/">CoVariations</a></li><li><a class="tocitem" href="../../man/data_directory/">Data directory</a></li><li><a class="tocitem" href="../../man/known_limitations/">Known limitations</a></li><li><a class="tocitem" href="../../man/physicell_studio/">PhysiCell Studio</a></li><li><a class="tocitem" href="../../man/sensitivity_analysis/">Sensitivity Analysis</a></li></ul></li><li><span class="tocitem">Documentation</span><ul><li><a class="tocitem" href="../VCTAnalysis/">VCTAnalysis</a></li><li><a class="tocitem" href="../VCTClasses/">VCTClasses</a></li><li><a class="tocitem" href="../VCTCompilation/">VCTCompilation</a></li><li><a class="tocitem" href="../VCTConfiguration/">VCTConfiguration</a></li><li class="is-active"><a class="tocitem" href>VCTCreation</a></li><li><a class="tocitem" href="../VCTDatabase/">VCTDatabase</a></li><li><a class="tocitem" href="../VCTDeletion/">VCTDeletion</a></li><li><a class="tocitem" href="../VCTExport/">VCTExport</a></li><li><a class="tocitem" href="../VCTHPC/">VCTHPC</a></li><li><a class="tocitem" href="../VCTICCell/">VCTICCell</a></li><li><a class="tocitem" href="../VCTImport/">VCTImport</a></li><li><a class="tocitem" href="../VCTLoader/">VCTLoader</a></li><li><a class="tocitem" href="../VCTModule/">VCTModule</a></li><li><a class="tocitem" href="../VCTMovie/">VCTMovie</a></li><li><a class="tocitem" href="../VCTPhysiCellStudio/">VCTPhysiCellStudio</a></li><li><a class="tocitem" href="../VCTPruner/">VCTPruner</a></li><li><a class="tocitem" href="../VCTRunner/">VCTRunner</a></li><li><a class="tocitem" href="../VCTSensitivity/">VCTSensitivity</a></li><li><a class="tocitem" href="../VCTUserAPI/">VCTUserAPI</a></li><li><a class="tocitem" href="../VCTVariations/">VCTVariations</a></li></ul></li><li><span class="tocitem">Miscellaneous</span><ul><li><a class="tocitem" href="../../misc/renaming/">Renaming</a></li></ul></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><a class="is-disabled">Documentation</a></li><li class="is-active"><a href>VCTCreation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>VCTCreation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/drbergman/pcvct" 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/drbergman/pcvct/blob/main/docs/src/lib/VCTCreation.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="VCTCreation"><a class="docs-heading-anchor" href="#VCTCreation">VCTCreation</a><a id="VCTCreation-1"></a><a class="docs-heading-anchor-permalink" href="#VCTCreation" title="Permalink"></a></h1><p>Create a new pcvct project.</p><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="pcvct.createProject" href="#pcvct.createProject"><code>pcvct.createProject</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">createProject(project_dir::String=&quot;.&quot;; clone_physicell::Bool=true, template_as_default::Bool=true, terse::Bool=false)</code></pre><p>Create a new pcvct project structure.</p><p>Creates a new project directory at <code>project_dir</code> with the following structure:</p><pre><code class="nohighlight hljs">project_dir
 ├── data
 ├── PhysiCell # The latest release from https://github.com/drbergman/PhysiCell
-└── VCT</code></pre><p><code>data</code> is populated with the standard structure. <code>PhysiCell</code> is a copy of PhysiCell. <code>VCT</code> contains a generated <code>GenerateData.jl</code> file.</p><p><strong>Arguments</strong></p><ul><li><code>project_dir::String=&quot;.&quot;</code>: The directory in which to create the project. Relative paths are resolved from the current working directory where Julia was launched.</li><li><code>clone_physicell::Bool=true</code>: Whether to clone the PhysiCell repository. If <code>false</code>, the latest release will be downloaded. Recommended to set to <code>true</code> so pcvct will be able to track changes to the PhysiCell repository.</li><li><code>template_as_default::Bool=true</code>: Whether to set up the project with the template files as the default. If <code>false</code>, the project will be set up with an empty structure.</li><li><code>terse::Bool=false</code>: Whether to generate a terse <code>GenerateData.jl</code> file. If <code>true</code>, the file will be generated without comments and explanations.</li></ul><p><strong>Note</strong></p><p>The names of the <code>data</code> and <code>PhysiCell</code> directories are fixed and cannot be changed. Their relative locations should not be changed without updating the <code>GenerateData.jl</code> file. The name of the <code>VCT</code> file and the <code>GenerateData.jl</code> are just by convention and can be changed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/drbergman/pcvct/blob/469a834da7f74ac0cf466fed3c94f51b0470c8b3/src/VCTCreation.jl#L5-L28">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../VCTConfiguration/">« VCTConfiguration</a><a class="docs-footer-nextpage" href="../VCTDatabase/">VCTDatabase »</a><div class="flexbox-break"></div><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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 23 January 2025 18:04">Thursday 23 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><div data-docstringscollapsed="true"></div></html>
+└── VCT</code></pre><p><code>data</code> is populated with the standard structure. <code>PhysiCell</code> is a copy of PhysiCell. <code>VCT</code> contains a generated <code>GenerateData.jl</code> file.</p><p><strong>Arguments</strong></p><ul><li><code>project_dir::String=&quot;.&quot;</code>: The directory in which to create the project. Relative paths are resolved from the current working directory where Julia was launched.</li><li><code>clone_physicell::Bool=true</code>: Whether to clone the PhysiCell repository. If <code>false</code>, the latest release will be downloaded. Recommended to set to <code>true</code> so pcvct will be able to track changes to the PhysiCell repository.</li><li><code>template_as_default::Bool=true</code>: Whether to set up the project with the template files as the default. If <code>false</code>, the project will be set up with an empty structure.</li><li><code>terse::Bool=false</code>: Whether to generate a terse <code>GenerateData.jl</code> file. If <code>true</code>, the file will be generated without comments and explanations.</li></ul><p><strong>Note</strong></p><p>The names of the <code>data</code> and <code>PhysiCell</code> directories are fixed and cannot be changed. Their relative locations should not be changed without updating the <code>GenerateData.jl</code> file. The name of the <code>VCT</code> file and the <code>GenerateData.jl</code> are just by convention and can be changed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/drbergman/pcvct/blob/030d1a506a9a85f87c40ec066ce781846cf81f92/src/VCTCreation.jl#L5-L28">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../VCTConfiguration/">« VCTConfiguration</a><a class="docs-footer-nextpage" href="../VCTDatabase/">VCTDatabase »</a><div class="flexbox-break"></div><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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 23 January 2025 21:04">Thursday 23 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><div data-docstringscollapsed="true"></div></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-23T18:04:12","documenter_version":"1.8.0"}}
		{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-23T21:04:10","documenter_version":"1.8.0"}}