bifurcationkit / BifurcationKit.jl

A Julia package to perform Bifurcation Analysis
https://bifurcationkit.github.io/BifurcationKitDocs.jl/stable
Other
288 stars 34 forks source link

Fix outdated use of camelCase names, et cetera #128

Closed danielwe closed 7 months ago

danielwe commented 7 months ago

Phew! I just wanted to try the Makie plot recipe, but it errored on calling getBranch instead of get_branch. I know you've been updating the naming conventions and that this is just an oversight, so I looked over the code and fixed all the leftover camelCase names I could find.

I found some other wrinkles along the way that are also fixed to the best of my ability in this PR

Where possible I tried to update commented-out lines of code, but I skipped commented sections that span entire files or large parts of files.

rveltz commented 7 months ago

Thanks a lot for doing this, that' an amazing work. Fixing the camelCase names took a lot of toll on me because I had to make sure the test were not breaking silently. I will review this as fast as I can.

Some methods of continuation were written using the keyword normN, and some examples were using this calling convention. However, reading the tests and other continuation methods, I believe the intention is to use normC in continuation and bifurcationdiagram et cetera, while normN is the name of the kwarg in newton and predictor. I updated the code accordingly.

Exactly, you are correct. Good catch.

One thing I did not push is a warning to tell the user when kwargs are undefined. You would have catched NormN easily.

Though it seems like the AbstractModulatedWave* types aren't used anyway?

I dont think it is. I planned to develop the waves a lot more but I might do it in a separate package.

rveltz commented 7 months ago

Phew! I just wanted to try the Makie plot recipe

This is kinda working but it is a bit clunky. The plot_solution definition is different from the one for Plots. Additionnally, I stopped developping the current one because I would like to write one with observables and that's beyond my knowledge for now.