Awesome
FourierFlows.jl
<p align="left"> <a href="https://buildkite.com/julialang/fourierflows-dot-jl"> <img alt="Buildkite CPU+GPU build status" src="https://img.shields.io/buildkite/4d921fc17b95341ea5477fb62df0e6d9364b61b154e050a123/main?logo=buildkite&label=Buildkite%20CPU%2BGPU"> </a> <a href="https://github.com/FourierFlows/FourierFlows.jl/actions/workflows/CI.yml"> <img alt="CI Status" src="https://github.com/FourierFlows/FourierFlows.jl/actions/workflows/CI.yml/badge.svg"> </a> <a href="https://FourierFlows.github.io/FourierFlowsDocumentation/stable"> <img alt="stable docs" src="https://img.shields.io/badge/documentation-stable%20release-blue"> </a> <a href="https://FourierFlows.github.io/FourierFlowsDocumentation/dev"> <img alt="latest docs" src="https://img.shields.io/badge/documentation-in%20development-orange"> </a> <a href="https://codecov.io/gh/FourierFlows/FourierFlows.jl"> <img src="https://codecov.io/gh/FourierFlows/FourierFlows.jl/branch/main/graph/badge.svg?token=BrgeSmKJHD"/> </a> <a href="https://github.com/SciML/ColPrac"> <img alt="ColPrac: Contributor's Guide on Collaborative Practices for Community Packages" src="https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet"> </a> <a href="https://doi.org/10.5281/zenodo.1161724"> <img alt="doi" src="https://zenodo.org/badge/DOI/10.5281/zenodo.1161724.svg" alt="DOI"> </a> </p>Overview
This software provides tools for partial differential equations on periodic domains using Fourier-based pseudospectral methods. A central intent of the software's design is also to provide a framework for writing new, fast solvers for new physical problems. The code is written in Julia.
For more details refer to the documentation.
Installation
To install, use Julia's built-in package manager to add the package and also to instantiate/build all the required dependencies
julia> using Pkg
julia> Pkg.add("FourierFlows")
julia> Pkg.instantiate()
The most recent version of FourierFlows.jl requires Julia v1.6 (the current long-term-release) or later.
Usage
See the documentation for tutorials on (i) how construct grids and use Fourier transform to compute derivatives and (ii) how to set up a PDE, time-step it forward, and visualize the output, (iii) how to add diagnostics, and (iv) how to write and read output from disk.
Scalability
For now, FourierFlows.jl is restricted to run on either a single CPU or single GPU. Multi-threading can enhance performance for the Fourier transforms. By default, FourierFlows.jl will use the maximum number of threads available on your machine. You can set the number of threads used by FourierFlows.jl by setting the environment variable, e.g.,
$ export JULIA_NUM_THREADS=4
For more information on multi-threading users are directed to the Julia Documentation.
If your machine has more than one GPU available, then functionality within CUDA.jl package
enables the user to choose the GPU device that FourierFlows.jl should use. The user is referred
to the CUDA.jl Documentation;
in particular, CUDA.devices
and CUDA.CuDevice.
Example(s)
A demonstration for how to code up and solve the linear shallow water equations is found in the Examples section of the documentation.
For more examples of FourierFlows.jl in action, see the child packages
GeophysicalFlows.jl
or PassiveTracerFlows.jl.
Getting help
Interested in using FourierFlows.jl or trying to figure out how to use it? Please feel free to ask us questions and get in touch! The documentation is always the best place to start. Check out the examples and open an issue or start a discussion if you have any questions, comments, suggestions, etc.
Developers
FourierFlows.jl started during the on Atmospheric and Oceanic Fluid Dynamics Meeting 2017 by Greg Wagner and Navid Constantinou. Since then various people have contributed.
Citing
This software is citable via zenodo. Please cite as:
Gregory L. Wagner, Navid C. Constantinou, and contributors. (2023). FourierFlows/FourierFlows.jl: FourierFlows v0.10.5 (Version v0.10.5). Zenodo. http://doi.org/10.5281/zenodo.1161724
Contributing
We are excited to get more people involved in contributing to the development of FourierFlows.jl! We welcome any contribution, no matter how big or small! It's always great to have new people look at the code with fresh eyes: you will see errors that other developers have missed.
Let us know by open an issue or start a discussion if you'd like to work on a new feature or implement a new module, if you're new to open-source and want to find a cool little project or issue to work on that fits your interests! We're more than happy to help along the way.
For more information, check out our contributor's guide.