FNFT

FNFT: A Software Library for Computing Nonlinear Fourier Transforms - Published in JOSS (2018)

https://github.com/fastnft/fnft

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 41 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: arxiv.org, joss.theoj.org
  • Committers with academic emails
    5 of 7 committers (71.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

c matlab-interface nonlinear-fourier-transform python-interface
Last synced: 4 months ago · JSON representation

Repository

Fast numerical computation of (inverse) nonlinear Fourier transforms

Basic Info
Statistics
  • Stars: 48
  • Watchers: 5
  • Forks: 12
  • Open Issues: 7
  • Releases: 9
Topics
c matlab-interface nonlinear-fourier-transform python-interface
Created almost 8 years ago · Last pushed 5 months ago
Metadata Files
Readme Changelog License

README.md

FNFT: Fast Nonlinear Fourier Transforms

Version Documentation Build Status DOI

FNFT is a software library for the numerical computation of (inverse) nonlinear Fourier transforms, which are also known as (inverse) scattering transforms. The focus of the library is on fast algorithms, but it also contains non-fast methods. FNFT is written in C and comes with a MATLAB interface. A Python interface is available separately.

Currently Implemented Cases

Forward Transforms

  • Nonlinear Schroedinger equation

    • Vanishing boundary conditions
      • Reflection coefficient and/or scattering coefficients (a and b)
      • Bound states (eigenvalues)
      • Norming constants and/or residues
    • (Quasi-)Periodic boundary conditions
      • Main spectrum
      • Auxiliary spectrum
  • Korteweg-de Vries equation

    • Vanishing boundary conditions
      • Reflection coefficient and/or scattering coefficients (a and b)
      • Bound states (eigenvalues)
      • Norming constants and/or residues
  • Manakov equation

    • Vanishing boundary conditions
      • Reflection coefficient and/or scattering coefficients (a, b1 and b2)
      • Bound states (eigenvalues)

Inverse Transforms

  • Nonlinear Schroedinger equation

    • Vanishing boundary conditions
      • Inversion of reflection coefficients, b-scattering coefficients or the inverse Fourier transform of the b-coefficient
      • Bound states (eigenvalues) can be added with arbitrary norming constants/residuals

Mailing List

Please join the FNFT mailing list if you want to be notified about new releases of FNFT. You can subscribe either using the web interface, or by sending an email with the subject "subscribe" to fnft-announcements-request@lists.tudelft.nl.

Citation

If you use FNFT for your academic work, please cite the accompanying software paper. Latex users can use the following BibTex entry.

@article{FNFT2018, author = {S. Wahls and S. Chimmalgi and P.J. Prins}, title = {{FNFT: A Software Library for Computing Nonlinear Fourier Transforms}}, journal = {{The Journal of Open Source Software}}, year = {2018}, volume = {3}, issue = {23}, pages = {597}, doi = {10.21105/joss.00597}, url = {https://doi.org/10.21105/joss.00597}, issn = {2475-9066} }

Installation

Please follow the instructions in the file INSTALL.md.

Getting started

Please read the file Getting-Started.md.

Community Guidelines

Please use the issue tracker to report any problems with the software. If you want to contribute to the development of FNFT, please email Sander Wahls.

Contributors

  • Sander Wahls, KIT (since July 2023) and TU Delft (before)
  • Shrinivas Chimmalgi, TU Delft
  • Peter J. Prins, TU Delft
  • Marius Brehler, TU Dortmund
  • Lianne de Vries, student TU Delft

License

FNFT is provided under the terms of the GNU General Public License, version 2.

Acknowledgements

  • This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 716669).

  • FNFT incorporates code from the Fortran library eiscor.

  • FNFT incorporates code from the C library Kiss FFT.

References

The algorithms in FNFT utilize ideas from the following references. More information can be found in the documentation of the individual routines.

Owner

  • Name: FastNFT
  • Login: FastNFT
  • Kind: organization

JOSS Publication

FNFT: A Software Library for Computing Nonlinear Fourier Transforms
Published
March 31, 2018
Volume 3, Issue 23, Page 597
Authors
Sander Wahls ORCID
Delft Center for Systems and Control, TU Delft, Delft, The Netherlands
Shrinivas Chimmalgi ORCID
Delft Center for Systems and Control, TU Delft, Delft, The Netherlands
Peter J. Prins ORCID
Delft Center for Systems and Control, TU Delft, Delft, The Netherlands
Editor
Kyle Niemeyer ORCID
Tags
Nonlinear Fourier transform Scattering transform

GitHub Events

Total
  • Issues event: 2
  • Watch event: 7
  • Issue comment event: 3
  • Push event: 10
Last Year
  • Issues event: 2
  • Watch event: 7
  • Issue comment event: 3
  • Push event: 10

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 563
  • Total Committers: 7
  • Avg Commits per committer: 80.429
  • Development Distribution Score (DDS): 0.567
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Sander Wahls s****s@t****l 244
ShrinivasJC s****i@t****l 125
Peter J. Prins p****s@t****l 119
Lianne de Vries l****v@l****l 46
Sander Wahls w****s@k****u 22
Marius Brehler m****r@t****e 6
Sander Wahls 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 26
  • Total pull requests: 55
  • Average time to close issues: 3 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 12
  • Total pull request authors: 5
  • Average comments per issue: 2.31
  • Average comments per pull request: 2.33
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: about 24 hours
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 3.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • wahls (6)
  • marbre (4)
  • xuchuang7916 (2)
  • Yarden92 (2)
  • ShrinivasJC (2)
  • simgunz (2)
  • PJ-Prins (2)
  • xmhk (2)
  • esf0 (1)
  • c5566b (1)
  • remifan (1)
Pull Request Authors
  • wahls (28)
  • PJ-Prins (12)
  • marbre (10)
  • ShrinivasJC (5)
  • ldvries (1)
Top Labels
Issue Labels
enhancement (6) code refactoring (1)
Pull Request Labels
bug (1) enhancement (1)