-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #54 from ProjectTorreyPines/docs
Cleanup and documentation
- Loading branch information
Showing
13 changed files
with
488 additions
and
421 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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: Make Docs | ||
on: | ||
pull_request: | ||
branches: ["master", "dev"] | ||
push: | ||
branches: | ||
- master | ||
- dev | ||
- docs | ||
paths: | ||
- '.github/workflows/make_docs.yml' | ||
- 'src/' | ||
- 'docs/**' | ||
tags: '*' | ||
workflow_dispatch: | ||
|
||
jobs: | ||
make_docs: | ||
permissions: | ||
actions: write | ||
contents: write | ||
statuses: write | ||
name: Documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: julia-actions/setup-julia@latest | ||
- uses: julia-actions/cache@v1 | ||
- name: Extract branch name | ||
shell: bash | ||
run: echo "branch=${GITHUB_BASE_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT | ||
id: extract_branch | ||
- name: Install dependencies | ||
run: | | ||
julia --project=docs/ -e 'using Pkg; Pkg.add(; url="https://github.com/ProjectTorreyPines/IMASDD.jl.git"); Pkg.add(; url="https://github.com/ProjectTorreyPines/GGDUtils.jl.git", rev="${{ steps.extract_branch.outputs.branch }}"); Pkg.add(; url="https://github.com/ProjectTorreyPines/SOLPS2IMAS.jl.git", rev="${{ steps.extract_branch.outputs.branch }}"); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' | ||
- name: Build and deploy | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | ||
run: julia --project=docs/ docs/make.jl |
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 |
---|---|---|
|
@@ -4,4 +4,5 @@ | |
# environment. | ||
Manifest.toml | ||
sd_input_data.json | ||
example/Project.toml | ||
example/*.toml | ||
docs/build |
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[deps] | ||
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" |
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 |
---|---|---|
@@ -0,0 +1,17 @@ | ||
using Documenter | ||
using SD4SOLPS | ||
|
||
makedocs(; | ||
modules=[SD4SOLPS], | ||
format=Documenter.HTML(), | ||
sitename="SD4SOLPS", | ||
checkdocs=:none, | ||
) | ||
|
||
deploydocs(; | ||
repo="github.com/ProjectTorreyPines/SD4SOLPS.jl.git", | ||
target="build", | ||
branch="gh-pages", | ||
devbranch="dev", | ||
versions=["stable" => "v^", "v#.#"], | ||
) |
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 |
---|---|---|
@@ -0,0 +1,99 @@ | ||
|
||
# SD4SOLPS.jl | ||
|
||
```@contents | ||
Pages = ["index.md"] | ||
Depth = 3 | ||
``` | ||
|
||
This repository serves as the top most workflow manager with helpful utilities to use other repositories in this project. | ||
|
||
## Documentation of other repositories in this project | ||
|
||
### [GGDUtils.jl](https://projecttorreypines.github.io/GGDUtils.jl/stable) | ||
|
||
### [SOLPS2IMAS.jl](https://projecttorreypines.github.io/SOLPS2IMAS.jl/stable) | ||
|
||
### [SynthDiag.jl](https://projecttorreypines.github.io/SynthDiag.jl/stable) | ||
|
||
## Installation | ||
|
||
### Using make: | ||
After cloning this repo, check the make menu: | ||
``` | ||
SD4SOLPS.jl % make help | ||
Help Menu | ||
make env_with_cloned_repo (or make r): Creates a Julia environment with the cloned repositories | ||
make env_with_git_url (or make u): Creates a Julia environment with the git urls without creating local clones | ||
make clean: Deletes Project.toml and Manifest.toml for a fresh start | ||
``` | ||
|
||
#### make r | ||
This option creates local copies of required private repositories at the same level as current repository and uses them in develop mode to create a Manifest.toml | ||
|
||
#### make u | ||
This option uses url of required private repositories to create a static Manifest.toml attached to current master branches of these repositories. | ||
|
||
#### make clean | ||
Deletes Manifest.toml so that environment can be recreated, to update or change the last used method. | ||
|
||
### Using Julia REPL and installing using Github url | ||
|
||
Or, in julia REPL: | ||
```julia | ||
julia> using Pkg; | ||
julia> Pkg.add(; url="https://github.com/ProjectTorreyPines/IMASDD.jl.git"); | ||
julia> Pkg.add(; url="https://github.com/ProjectTorreyPines/GGDUtils.jl.git"); | ||
julia> Pkg.add(; url="https://github.com/ProjectTorreyPines/SOLPS2IMAS.jl.git"); | ||
julia> Pkg.add(; url="https://github.com/JuliaFusion/EFIT.jl.git"); | ||
julia> Pkg.add(; url="https://github.com/ProjectTorreyPines/SD4SOLPS.jl.git"); | ||
julia> Pkg.instantiate() | ||
``` | ||
|
||
## Top file handling functions | ||
|
||
```@docs | ||
find_files_in_allowed_folders | ||
geqdsk_to_imas! | ||
preparation | ||
``` | ||
|
||
## Repairing/filling out partial equilibrium files | ||
|
||
Tools for repairing/filling out partial equilibrium files. | ||
|
||
Some of the added fields may not be totally accurate, so it is recommended to | ||
use this tool mainly for test cases, as a utility. For a real equilibrium, | ||
problems should be fixed properly. | ||
|
||
```@docs | ||
add_rho_to_equilibrium! | ||
check_rho_1d | ||
``` | ||
|
||
## Extrapolations | ||
|
||
Utilities for extrapolating profiles | ||
|
||
### Core profile extrapolations | ||
|
||
```@docs | ||
extrapolate_core | ||
fill_in_extrapolated_core_profile! | ||
``` | ||
|
||
### Edge profiles extrapolations | ||
|
||
These functions have not been fully tested and/or supported yet. | ||
|
||
```@docs | ||
mesh_psi_spacing | ||
cached_mesh_extension! | ||
``` | ||
|
||
## Unit conversion utilities | ||
|
||
```@docs | ||
gas_unit_converter | ||
``` |
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 |
---|---|---|
|
@@ -8,6 +8,15 @@ | |
"source": [ | ||
"using Pkg;\n", | ||
"Pkg.activate(\"./\")\n", | ||
"\n", | ||
"# Can comment these after the first run\n", | ||
"Pkg.add(; url=\"[email protected]:ProjectTorreyPines/IMASDD.jl.git\");\n", | ||
"Pkg.add(; url=\"[email protected]:ProjectTorreyPines/GGDUtils.jl.git\");\n", | ||
"Pkg.add(; url=\"[email protected]:ProjectTorreyPines/SOLPS2IMAS.jl.git\");\n", | ||
"Pkg.add(; url=\"[email protected]:ProjectTorreyPines/SynthDiag.jl.git\");\n", | ||
"Pkg.add(; url=\"[email protected]:JuliaFusion/EFIT.jl.git\");\n", | ||
"Pkg.add(; url=\"[email protected]:ProjectTorreyPines/SD4SOLPS.jl.git\");\n", | ||
"\n", | ||
"Pkg.instantiate()" | ||
] | ||
}, | ||
|
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.