FlowSieve

About FlowSieve

FlowSieve is developed as an open resource by the Complex Flow Group at the University of Rochester, under the sponsorship of the National Science Foundation and the National Aeronautics and Space Administration. Continued support for FlowSieve depends on demonstrable evidence of the code’s value to the scientific community. We kindly request that you cite the code in your publications and presentations. FlowSieve is made available under The Open Software License 3.0 (OSL-3.0) (see the license file or the human-readable summary at the end of the README), which means it is open to use, but requires attribution.

The following citations are suggested:

For journal articles, proceedings, etc.., we suggest: * Storer et al., (2023). FlowSieve: A Coarse-Graining Utility for Geophysical Flows on the Sphere. Journal of Open Source Software, 8(84), 4277, (https://doi.org/10.21105/joss.04277) * Storer et al., (2022). Global energy spectrum of the general oceanic circulation. Nature Communications, 13, 5314, (https://doi.org/10.1038/s41467-022-33031-3) * Aluie, Hussein, (2019). Convolutions on the sphere: Commutation with differential operators. GEM-International Journal on Geomathematics, 10.1, 1-31, (https://doi.org/10.1007/s13137-019-0123-9)

Other articles that may be relevant to the work are: * Aluie, Hussein, Matthew Hecht, and Geoffrey K. Vallis, (2018). Mapping the energy cascade in the North Atlantic Ocean: The coarse-graining approach. Journal of Physical Oceanography, 48.2, 225-244, (https://doi.org/10.1175/JPO-D-17-0100.1)

For presentations, posters, etc.., we suggest acknowledging: * FlowSieve code from the Complex Flow Group at University of Rochester

Community Guidelines

• Contributing
  • At the current stage of development, anyone seeking to contribute to the FlowSieve codebase is asked to contact the main developers (see Seeking Support) to discuss the best way to integrate their contributions. The codebase is maintained on GitHub, and contributions will ultimately result in merging commits into the main branch.
  • It is recommended to use a forked repository for active development, since it allows testing in a separate environment before merging.
• Reporting Issues
  • Please report issues using the GitHub issue tracking tools (https://github.com/husseinaluie/FlowSieve/issues). Issues can also be submitted by email (see Seeking Support), but the issue tracker is preferred.
• Seeking Support
  • The best way to obtain support is to contact Hussein Aluie or Benjamin Storer by email. Contact information is available at the Complex Flow Group webpage (http://www.complexflowgroup.com/people/).

FlowSieve documentation is available here.

Licence

This is a brief human-readable summary of the license, and is not the actual licence. See licence.md for the full licence details.

You are free: * To share: To copy, distribute and use the database. * To create: To produce works from the database. * To adapt: To modify, transform and build upon the database.

As long as you: * Attribute: You must attribute any public use of the database, or works produced from the database, in the manner specified in the license. For any use or redistribution of the database, or works produced from it, you must make clear to others the license of the database and keep intact any notices on the original database.