search

jmert / AssociatedLegendrePolynomials.jl

A library for calculating the Associated Legendre polynomials
https://jmert.github.io/AssociatedLegendrePolynomials.jl/
MIT License
20 stars 2 forks source link

Register the Package? #28

Closed jakebolewski closed 2 years ago

jakebolewski commented 2 years ago

Hi we were looking at some of the packages functionality for the CLIMA project, but having the package not registered is kind of a blocker for more than experimental use. It would be great if it were added to the Julia Registry.

jmert commented 2 years ago

Thank you for showing interest in my package!

I'll consider it over the next few days — maybe some action this weekend. My one concern is that registration with the existing name may be denied because it is pretty generic. There's a reasonable argument to be made that it should probably be named LegendreFunctions.jl or LegendrePolynomials.jl, but I could get away with the shorter name when building it for my own use.

jakebolewski commented 2 years ago

LegendrePolynomials seems like a good / potentially more descriptive name, maybe @simonbyrne has some thoughts. As for the name change, in newer versions of julia you can do import LegendrePloynomials as Legendre now to stick with the shorter alias in your existing work.

Anyways thanks for considering and if you need any help let us know. I enjoyed the blog series that went into the design of the package BTW.

jmert commented 2 years ago

Version 1.0 has been submitted for registration as AssociatedLegendrePolynomials.jl — https://github.com/JuliaRegistries/General/pull/50660

I'm glad you enjoyed the article series! I don't enjoy writing, but I do find written explanations are hugely useful to others and to myself (either in focusing my understanding in just coherently explaining something, or to remind myself in the future what past-me figured out).

jakebolewski commented 2 years ago

Thanks!

simonbyrne commented 2 years ago

Thanks, and I also wanted to iterate my appreciation for the blog posts: https://justinwillmert.com/articles/2020/introduction-to-associated-legendre-polynomials/ You should link to them from the docs, they were very helpful and well written!

jmert commented 2 years ago

Thank you. I did actually add a link to them into the References section of the docs just before publishing: https://jmert.github.io/AssociatedLegendrePolynomials.jl/stable/man/references/