Initial Commit

Project.toml

@@ -1,5 +1,5 @@
-name = "REPLACE_PKG"
-uuid = "a50c839e-1b84-4575-b48f-4fda80ec5e07"
+name = "ShockCooling"
+uuid = "c71b61e4-c631-4a95-b02e-ad61a3a6763b"
 authors = ["Patrick Armstrong <patrick.armstrong@anu.edu.au> and contributors"]
 version = "0.1.0"
 

README.md

@@ -1 +1 @@
-# REPLACE_PKG 
+# ShockCooling 

doc/make.jl

@@ -1,14 +1,14 @@
 using Documenter
 push!(LOAD_PATH, "../src/")
-using REPLACE_PKG
+using ShockCooling
 
-DocMeta.setdocmeta!(REPLACE_PKG, :DocTestSetup, :(using REPLACE_PKG); recursive=true)
+DocMeta.setdocmeta!(ShockCooling, :DocTestSetup, :(using ShockCooling); recursive=true)
 
 makedocs(
-    sitename="REPLACE_PKG Documentation",
-    modules = [REPLACE_PKG],
+    sitename="ShockCooling Documentation",
+    modules = [ShockCooling],
     pages = [
-        "REPLACE_PKG" => "index.md",
+        "ShockCooling" => "index.md",
         "API" => "api.md"
     ],
     format = Documenter.HTML(
@@ -17,5 +17,5 @@ makedocs(
 )
 
 deploydocs(
-    repo = "github.com/OmegaLambda1998/REPLACE_PKG.jl.git"
+    repo = "github.com/OmegaLambda1998/ShockCooling.jl.git"
 )

doc/src/api.md

@@ -5,30 +5,30 @@
 Pages = ["api.md"]
 Depth = 5
 ```
-## REPLACE_PKG Functions
+## ShockCooling Functions
 
 ```@meta
-CurrentModule = REPLACE_PKG
+CurrentModule = ShockCooling
 ```
 
 ### Public Objects
 
 ```@autodocs
-Modules = [REPLACE_PKG]
+Modules = [ShockCooling]
 Private = false
 ```
 
 ### Private Objects
 
 ```@autodocs
-Modules = [REPLACE_PKG]
+Modules = [ShockCooling]
 Public = false
 ```
 
-## REPLACE_PKG.RunModule Functions
+## ShockCooling.RunModule Functions
 
 ```@meta
-CurrentModule = REPLACE_PKG.RunModule
+CurrentModule = ShockCooling.RunModule
 ```
 
 ### Public Objects

doc/src/index.md

@@ -1,10 +1,12 @@
-# REPLACE_PKG Documentation
+# ShockCooling Documentation
+
+[ShockCooling.jl](https://github.com/OmegaLambda1998/ShockCooling.jl)
 
 ```@contents
 ```
 
 ## Install
 ```
 using Pkg
-Pkg.add("REPLACE_PKG")
+Pkg.add("ShockCooling")
 ```

scripts/REPLACE_PKG → scripts/ShockCooling

@@ -15,6 +15,6 @@ export JULIA_PROJECT=$DIR/.. # $DIR is the scripts directory, so we go up a leve
 export JULIA_LOAD_PATH=@:@stdlib  # exclude default environment
 exec env LD_LIBRARY_PATH="" $JULIA_CMD -e 'include(popfirst!(ARGS))' "$SOURCE" "$@"
 =#
-include("../src/REPLACE_PKG.jl")
-using .REPLACE_PKG
+include("../src/ShockCooling.jl")
+using .ShockCooling
 main()

src/RunModule.jl

@@ -5,17 +5,17 @@ module RunModule
 # Internal Packages
 
 # Exports
-export run_REPLACE_PKG
+export run_ShockCooling
 
 """
-    run_REPLACE_PKG(toml::Dict{String, Any})
+    run_ShockCooling(toml::Dict{String, Any})
 
 Main entrance function for the package
 
 # Arguments
 - `toml::Dict{String, Any}`: Input toml file containing all options for the package
 """
-function run_REPLACE_PKG(toml::Dict{String, Any})
+function run_ShockCooling(toml::Dict{String, Any})
 end
 
 end

src/REPLACE_PKG.jl → src/ShockCooling.jl

@@ -1,4 +1,4 @@
-module REPLACE_PKG
+module ShockCooling
 
 # External packages
 using TOML
@@ -8,7 +8,7 @@ using StatProfilerHTML
 
 # Internal Packages
 include("RunModule.jl")
-using .RunModule: run_REPLACE_PKG
+using .RunModule: run_ShockCooling
 
 # Exports
 export main 
@@ -55,9 +55,9 @@ function main()
     toml_path = args["input"]
     toml = setup_input(toml_path, verbose)
     if args["profile"]
-        @profilehtml run_REPLACE_PKG(toml)
+        @profilehtml run_ShockCooling(toml)
     else
-        run_REPLACE_PKG(toml)
+        run_ShockCooling(toml)
     end
 end
 

test/runtests.jl

@@ -1,6 +1,6 @@
-using REPLACE_PKG
+using ShockCooling
 using Test
 
-@testset "REPLACE_PKG.jl" begin
+@testset "ShockCooling.jl" begin
     # Write your tests here.
 end