-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Apr 9, 2024
1 parent
0000952
commit 668831d
Showing
3 changed files
with
3 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-09T00:15:24","documenter_version":"1.3.0"}} | ||
| {"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-09T00:18:57","documenter_version":"1.3.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 · OWENSOpenFASTWrappers.jl</title><meta name="title" content="Home · OWENSOpenFASTWrappers.jl"/><meta property="og:title" content="Home · OWENSOpenFASTWrappers.jl"/><meta property="twitter:title" content="Home · OWENSOpenFASTWrappers.jl"/><meta name="description" content="Documentation for OWENSOpenFASTWrappers.jl."/><meta property="og:description" content="Documentation for OWENSOpenFASTWrappers.jl."/><meta property="twitter:description" content="Documentation for OWENSOpenFASTWrappers.jl."/><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>OWENSOpenFASTWrappers.jl</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><ul class="internal"><li><a class="tocitem" href="#Quick-Start-for-Developing-Julia-Packages"><span>Quick Start for Developing Julia Packages</span></a></li></ul></li><li><a class="tocitem" href="reference/reference/">API Reference</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/sandialabs/OWENSOpenFASTWrappers.jl" 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/sandialabs/OWENSOpenFASTWrappers.jl/blob/master/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="OWENSOpenFASTWrappers"><a class="docs-heading-anchor" href="#OWENSOpenFASTWrappers">OWENSOpenFASTWrappers</a><a id="OWENSOpenFASTWrappers-1"></a><a class="docs-heading-anchor-permalink" href="#OWENSOpenFASTWrappers" title="Permalink"></a></h1><p>A repository containing julia wrappers for standalone openFAST modules.</p><h2 id="Quick-Start-for-Developing-Julia-Packages"><a class="docs-heading-anchor" href="#Quick-Start-for-Developing-Julia-Packages">Quick Start for Developing Julia Packages</a><a id="Quick-Start-for-Developing-Julia-Packages-1"></a><a class="docs-heading-anchor-permalink" href="#Quick-Start-for-Developing-Julia-Packages" title="Permalink"></a></h2><p>Please make all feature changes and bug fixes as branches and then create pull requests against the dev branch. The dev branch will be periodically pulled into master.</p><ul><li><p>include("./path/modulename.jl/src/modulename.jl") is like a copy and paste and will reload the module every time the script is run</p></li><li><p>installing a module by navigating to the module's working directory (and in an interactive julia session), running "] dev ." will install it in dev mode and will pick up changes made in the local package location every time julia restarts.</p></li><li><p>installing normally ("] add url/or/path/2/package") installs the package in the "~/.julia" folder and requires the url/path original location to be updated, and a "] update mypackage" to get it to pick up changes.</p></li><li><p>Each package has its own "environment" like conda environment. To activate that environment and add dependencies, navigate to the working directory and run "] activate ." Then, when you "] add dependencyname" it will add it to the Project.toml and Manifest.toml automatically. To switch back to the general environment, run "] activate"</p></li><li><p>Add code in the src/ folder with an include("./yournewfile.jl") in the OpenFASTWrapers.jl file</p></li><li><p>Add tests and test data in the test/ folder, add include statements for your tests in the runtests.jl file.</p></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/reference/">API Reference »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 9 April 2024 00:15">Tuesday 9 April 2024</span>. Using Julia version 1.10.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 · OWENSOpenFASTWrappers.jl</title><meta name="title" content="Home · OWENSOpenFASTWrappers.jl"/><meta property="og:title" content="Home · OWENSOpenFASTWrappers.jl"/><meta property="twitter:title" content="Home · OWENSOpenFASTWrappers.jl"/><meta name="description" content="Documentation for OWENSOpenFASTWrappers.jl."/><meta property="og:description" content="Documentation for OWENSOpenFASTWrappers.jl."/><meta property="twitter:description" content="Documentation for OWENSOpenFASTWrappers.jl."/><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>OWENSOpenFASTWrappers.jl</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><ul class="internal"><li><a class="tocitem" href="#Quick-Start-for-Developing-Julia-Packages"><span>Quick Start for Developing Julia Packages</span></a></li></ul></li><li><a class="tocitem" href="reference/reference/">API Reference</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/sandialabs/OWENSOpenFASTWrappers.jl" 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/sandialabs/OWENSOpenFASTWrappers.jl/blob/master/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="OWENSOpenFASTWrappers"><a class="docs-heading-anchor" href="#OWENSOpenFASTWrappers">OWENSOpenFASTWrappers</a><a id="OWENSOpenFASTWrappers-1"></a><a class="docs-heading-anchor-permalink" href="#OWENSOpenFASTWrappers" title="Permalink"></a></h1><p>A repository containing julia wrappers for standalone openFAST modules.</p><h2 id="Quick-Start-for-Developing-Julia-Packages"><a class="docs-heading-anchor" href="#Quick-Start-for-Developing-Julia-Packages">Quick Start for Developing Julia Packages</a><a id="Quick-Start-for-Developing-Julia-Packages-1"></a><a class="docs-heading-anchor-permalink" href="#Quick-Start-for-Developing-Julia-Packages" title="Permalink"></a></h2><p>Please make all feature changes and bug fixes as branches and then create pull requests against the dev branch. The dev branch will be periodically pulled into master.</p><ul><li><p>include("./path/modulename.jl/src/modulename.jl") is like a copy and paste and will reload the module every time the script is run</p></li><li><p>installing a module by navigating to the module's working directory (and in an interactive julia session), running "] dev ." will install it in dev mode and will pick up changes made in the local package location every time julia restarts.</p></li><li><p>installing normally ("] add url/or/path/2/package") installs the package in the "~/.julia" folder and requires the url/path original location to be updated, and a "] update mypackage" to get it to pick up changes.</p></li><li><p>Each package has its own "environment" like conda environment. To activate that environment and add dependencies, navigate to the working directory and run "] activate ." Then, when you "] add dependencyname" it will add it to the Project.toml and Manifest.toml automatically. To switch back to the general environment, run "] activate"</p></li><li><p>Add code in the src/ folder with an include("./yournewfile.jl") in the OpenFASTWrapers.jl file</p></li><li><p>Add tests and test data in the test/ folder, add include statements for your tests in the runtests.jl file.</p></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/reference/">API Reference »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 9 April 2024 00:18">Tuesday 9 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Large diffs are not rendered by default.
Oops, something went wrong.