remove gitmodule examples (#239)

NonlinearOscillations · Sep 16, 2024 · 33d78c7 · 33d78c7 · oameye · Sep 16, 2024
1 parent 3016dcd
commit 33d78c7
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,5 @@ docs/build/**
 examples/jdp.mplstyle
 docs/node_modules/** 
 docs/package-lock.json
+*.ipynb
+examples/parametron_result.jld2
diff --git a/.gitmodules b/.gitmodules
diff --git a/docs/make_md_examples.jl b/docs/make_md_examples.jl
@@ -2,10 +2,11 @@ using Literate
 
 ### Process examples
 # Always rerun examples
-const EXAMPLES_IN = joinpath(@__DIR__, "src", "examples")
-const OUTPUT_MD_DIR = joinpath(@__DIR__, "src/examples")
+const EXAMPLES_IN = joinpath(@__DIR__, "..", "examples")
+const OUTPUT_MD_DIR = joinpath(@__DIR__, "src", "examples")
 
 examples = filter!(file -> file[(end - 2):end] == ".jl", readdir(EXAMPLES_IN; join=true))
+filter!(file -> !contains(file, "make_nb_examples"), examples)
 
 if isempty(get(ENV, "CI", ""))
     # only needed when building docs locally; set automatically when built under CI

diff --git a/examples b/examples
diff --git a/examples/Project.toml b/examples/Project.toml
@@ -0,0 +1,14 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
+HarmonicBalance = "e13b9ff6-59c3-11ec-14b1-f3d2cc6c135e"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
+ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
+OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+SteadyStateDiffEq = "9672c7b4-1e72-59bd-8a11-6ac3964bc41f"
+
+[compat]
+Documenter = "1"
+julia = "1.9"
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,9 @@
+# HarmonicBalance notebooks
+
+This repo contains a collection of example Jupyter notebooks using [HarmonicBalance.jl](https://github.com/NonlinearOscillations/HarmonicBalance.jl)
+
+A detailed description of each example can be found at the [documentation](https://nonlinearoscillations.github.io/HarmonicBalance.jl/).
+
+If you would like to contribute your favourite system, feel free to get in touch, or simply open a pull request to this repo and the documentation. Also, if you use HarmonicBalance.jl in your project, we kindly ask you to cite [this paper](https://scipost.org/SciPostPhysCodeb.6)
+
+
diff --git a/examples/make_nb_examples.jl b/examples/make_nb_examples.jl
@@ -0,0 +1,16 @@
+using Literate
+
+using HarmonicBalance, Plots
+default(; fmt=:png)
+
+### Process examples
+# Always rerun examples
+const EXAMPLES_IN = @__DIR__
+const OUTPUT_NB_DIR = @__DIR__
+
+examples = filter!(file -> file[(end - 2):end] == ".jl", readdir(EXAMPLES_IN; join=true))
+filter!(file -> !contains(file, "make_nb_examples"), examples)
+
+for example in examples
+    Literate.notebook(example, OUTPUT_NB_DIR; documenter=false, execute=true)
+end
diff --git a/...mples/parametric_via_three_wave_mixing.jl → examples/parametric_via_three_wave_mixing.jl b/...mples/parametric_via_three_wave_mixing.jl → examples/parametric_via_three_wave_mixing.jl
diff --git a/docs/src/examples/parametron.jl → examples/parametron.jl b/docs/src/examples/parametron.jl → examples/parametron.jl
diff --git a/docs/src/examples/wave_mixing.jl → examples/wave_mixing.jl b/docs/src/examples/wave_mixing.jl → examples/wave_mixing.jl