Metadata-Version: 2.1
Name: xcompact3d_toolbox
Version: 0.1.3
Summary: A set of tools for pre and postprocessing prepared for the high-order Navier-Stokes solver Xcompact3d
Home-page: https://github.com/fschuch/xcompact3d_toolbox
Author: Felipe N. Schuch
Author-email: felipe.schuch@edu.pucrs.br
License: UNKNOWN
Description: # Xcompact3d Toolbox
        
        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.
        
        The physical and computational parameters are built on top of [traitlets](https://traitlets.readthedocs.io/en/stable/index.html),
        a framework that lets Python classes have attributes with type checking, dynamically calculated default values, and ‘on change’ callbacks.
        In addition to [ipywidgets](https://ipywidgets.readthedocs.io/en/latest/) for an user friendly interface.
        
        Data structure is provided by [xarray](http://xarray.pydata.org/en/stable/), that introduces labels in the form of dimensions, coordinates and attributes on top of raw [NumPy](https://numpy.org/)-like arrays, which allows for a more intuitive, more concise, and less error-prone developer experience. It integrates tightly with [dask](https://dask.org/) for parallel computing.
        
        Finally, Xcompact3d Toolbox is fully integrated with the new *Sandbox Flow Configuration* (see [fschuch/Xcompact3d](https://github.com/fschuch/Xcompact3d/)). The idea is to easily provide everything that X3d needs from a Python Jupyter Notebook, like initial conditions, solid geometry, boundary conditions, and the parameters. It makes life easier for beginners, that can run any new flow configuration without worrying about Fortran and [2decomp](http://www.2decomp.org/). For developers, it works as a rapid prototyping tool, to test concepts and then compare results to validate any future Fortran implementations.
        
        ## Installation
        
        `pip install xcompact3d-toolbox`
        
        ## Documentation
        
        Under preparation.
        
        ## Copyright and License
        
        (c) 2020 [Felipe N. Schuch](https://fschuch.github.io/). All content is under [GPL-3.0 License](https://github.com/fschuch/xcompact3d_toolbox/blob/master/LICENSE).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
