Skip to content

Commit b19baba

Browse files
committed
docs: add paper
1 parent 9ca9f8f commit b19baba

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

paper/paper.bib

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,3 +181,14 @@ @ARTICLE{2020SciPy-NMeth
181181
adsurl = {https://rdcu.be/b08Wh},
182182
doi = {10.1038/s41592-019-0686-2},
183183
}
184+
185+
186+
@inproceedings{hagberg_exploring_2008,
187+
location = {Pasadena, {CA} {USA}},
188+
title = {Exploring Network Structure, Dynamics, and Function using {NetworkX}},
189+
pages = {11 -- 15},
190+
booktitle = {Proceedings of the 7th Python in Science Conference},
191+
author = {Hagberg, Aric A. and Schult, Daniel A. and Swart, Pieter J.},
192+
editor = {Varoquaux, Gaël and Vaught, Travis and Millman, Jarrod},
193+
date = {2008},
194+
}

paper/paper.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,12 @@ Our packages would allow researchers to easily extend their work to higher dimen
4040

4141
# Statement of need
4242

43-
`ultrasphere` is a Python package for Vilenkin–Kuznetsov–Smorodinsky (VKS) polyspherical coordinate systems [@vilenkin_representation_1993].
43+
`ultrasphere` is a Python package for Vilenkin–Kuznetsov–Smorodinsky (VKS) polyspherical coordinate systems [@vilenkin_representation_1993; @cohl_fourier_2012].
4444
`ultrasphere-harmonics` implements hyperspherical harmonics methods for any type of polyspherical coordinates based on `ultrasphere`.
4545
While spherical harmonics in 3D itself have been widely implemented in various software packages, such as Scipy [@2020SciPy-NMeth], hyperspherical harmonics are rarely implemented, and software packages which supports arbitrary VKS polyspherical coordinates are not known.
46-
The main goal of out packages is to provide a unified framework for implementing spherical harmonics techniques in arbitrary VKS polyspherical coordinates and dimensions.
47-
To demonstrate this, code for solving acoustic scattering from a single sound-soft sphere using any type of polyspherical coordinates is implemented within `ultrasphere-harmonics` as a command-line application.
46+
To remedy this, our packages allows to convert between Cartesian coordinates and VKS polyspherical coordinates, compute hyperspherical harmonics, elementary solutions to the Helmholtz equation, hyperspherical expansion of a function, and the translational coefficients of elementary solutions of the Helmholtz equation under arbitrary VKS polyspherical coordinates and dimensions.
47+
Our package especially utilizes NetworkX [@hagberg_exploring_2008] to make use of the tree structure of VKS polyspherical coordinates, which is known as
48+
To illustrate the usage of our packages, example code for solving acoustic scattering from a single sound-soft sphere using any type of VKS polyspherical coordinates is implemented in `ultrasphere-harmonics` as a command-line application.
4849

4950
Spherical expansion methods are sometimes computationally expensive, especially in higher dimensions.
5051
To utilize HPC resources, which environment is recently diversified, our api is made to be compatible with the array API standard [@meurer_python_2023], which enables writing code which runs on multiple array libraries (e.g., NumPy[@harris_array_2020], PyTorch[@paszke_pytorch_2019]) and multiple hardware (e.g., CPU, GPU).

0 commit comments

Comments
 (0)