Skip to main content

A set of tools for pre and postprocessing prepared for the high-order Navier-Stokes solver Xcompact3d

Project description

Xcompact3d Toolbox

Build Status Documentation Status PyPI version Code style: black

It is a Python package designed to handle the pre and postprocessing of the high-order Navier-Stokes solver Xcompact3d. It aims to help users and code developers with a set of tools and automated processes.

Xcompact3d Toolbox is still in pre-release, be aware that new features are going to be added to it and the current features may change with no further notice.

The physical and computational parameters are built on top of traitlets, a framework that lets Python classes have attributes with type checking, dynamically calculated default values, and ‘on change’ callbacks. In addition to ipywidgets for an user friendly interface.

Data structure is provided by xarray (see Why xarray?), that introduces labels in the form of dimensions, coordinates and attributes on top of raw NumPy-like arrays, which allows for a more intuitive, more concise, and less error-prone developer experience. It integrates tightly with dask for parallel computing.

Finally, Xcompact3d Toolbox is fully integrated with the new Sandbox Flow Configuration (see fschuch/Xcompact3d). The idea is to easily provide everything that X3d needs from a Jupyter Notebook, like initial conditions, solid geometry, boundary conditions, and the parameters (see examples). It makes life easier for beginners, that can run any new flow configuration without worrying about Fortran and 2decomp. For developers, it works as a rapid prototyping tool, to test concepts and then compare results to validate any future Fortran implementation.


pip install xcompact3d-toolbox

Useful links

Try it Online

badge badge

Click on any link above to launch Binder and interact with our notebooks in a live environment!

Copyright and License

All content is under GPL-3.0 License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xcompact3d-toolbox, version 0.1.11
Filename, size File type Python version Upload date Hashes
Filename, size xcompact3d_toolbox-0.1.11-py3-none-any.whl (59.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size xcompact3d_toolbox-0.1.11.tar.gz (63.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page