JuliaApproximation / JuliaApproximation/FastTransforms.jl
More documentation / examples?
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 281
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
I am interested in a Julia package for spin-weighted spherical harmonics (or vector spherical harmonics). I like FastTransforms.jl, but I found it difficult to get started. While experimenting with FastTransforms.jl, I wrote a package https://github.com/eschnett/FastSphericalHarmonics.jl that is a shim around FastTransforms.jl, adding documentation, examples, and test cases (to ensure my understanding of the technical details is correct). I also added a few functions that are easier to use for beginners.
I'd be happy to create a pull request to move the respective parts of FastSphericalHarmonics.jl into FastTransforms.jl. If so, would you have any particular requests for how to organise this?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing FastSphericalHarmonics.jl and comparing its documentation, examples, and test cases with FastTransforms.jl. Identify which beginner-oriented material and functions could be moved, then confirm the desired organisation with maintainers. Done means an agreed subset is integrated into FastTransforms.jl with its examples and tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100