Skip to content

Latest commit

 

History

History
207 lines (153 loc) · 4.63 KB

overview.md

File metadata and controls

207 lines (153 loc) · 4.63 KB
Raw
jupytext kernelspec
text_representation
extension format_name format_version jupytext_version
.md
myst
0.13
1.16.1
display_name language name
Python 3
python
python3
 
from fluiddoc import mock_modules

mock_modules(('nbstripout', 'scipy', 'scipy.fftpack', 'scipy.interpolate',
              'skimage', 'skimage.io'))

Main features of the fluiddyn package

We here give an overview of the main features of the package. Fluiddyn contains pure python code useful when developing and using fluiddyn packages. It is like the Ali Baba's cave of the fluiddyn project. Here, we just show typical import commands and point towards pages in the documentation.

Just importing the main package can be useful:

import fluiddyn as fld

fld.constants.g

fld.time_as_str()

fld.get_memory_usage()

fld.ipydebug

is a function to debug code with ipython (simpler than with pdb or ipdb):

Subpackage fluiddyn.output

The subpackage :mod:`fluiddyn.output` ("scientific outputs" like figures and movies) uses (and imports) matplotlib.

from fluiddyn.output import show, set_rcparams, gradient_colors

Subpackage fluiddyn.io

The subpackage :mod:`fluiddyn.io` ("input/output") contains modules to save and load data in many formats:

from fluiddyn.io import (
    binary, txt, mycsv, hdf5, digiflow, dantec, davis, multitiff, in_py, image)

from fluiddyn.io.query import query_yes_no, query, query_number
from fluiddyn.io.tee import MultiFile

There is also a function to disable the standard output which we use a lot in unittests.

from fluiddyn.io import stdout_redirected

fluiddump

This package also contains the code of a very simple utility to dump hdf5 and netcdf files (without dependency in the netcdf library and in the program h5dump)

from fluiddyn.io.dump import dump_h5_file, dump_nc_file

! fluiddump -h

Subpackage fluiddyn.util

The subpackage :mod:`fluiddyn.util` contains functions and modules to do very different things:

from fluiddyn.util import (
    time_as_str, get_memory_usage, print_memory_usage,
    import_class, is_run_from_ipython)

# very simple use of mpi (no dependency on mpi4py if the process is run without mpi)
from fluiddyn.util import mpi

# storing parameters
from fluiddyn.util.paramcontainer import ParamContainer
from fluiddyn.util.paramcontainer_gui import QtParamContainer

# handling series of arrays in files
from fluiddyn.util.serieofarrays import SerieOfArraysFromFiles, SeriesOfArrays

# "tickers"
from fluiddyn.util.timer import Timer, TimerIrregular

# daemon
from fluiddyn.util.daemons import DaemonThread, DaemonProcess

# emails
from fluiddyn.util import mail

# matlab to py (command line utility fluidmat2py)
from fluiddyn.util.matlab2py import cleanmat, mat2wrongpy

Logging

from fluiddyn.util.logger import Logger
from fluiddyn.util import terminal_colors
from fluiddyn.util import config_logging

from fluiddyn.util.terminal_colors import cprint
cprint("RED", color="RED")
cprint.cyan("cyan")
cprint.light_blue("bold light blue", bold=True)

fluidinfo: gather information on your Python environment

from fluiddyn.util import info

!fluidinfo -h

Subpackage fluiddyn.calcul

The subpackage :mod:`fluiddyn.calcul` provides helpers for simple numerical computing.

from fluiddyn.calcul import easypyfft

from fluiddyn.calcul import sphericalharmo

from fluiddyn.calcul import signal

from fluiddyn.calcul.setofvariables import SetOfVariables

Subpackage fluiddyn.clusters

The subpackage :mod:`fluiddyn.clusters` provides classes helping to use computer clusters.

from fluiddyn.clusters.legi import Calcul8 as Cluster
Cluster.print_doc_commands()

from fluiddyn.clusters.cines import Occigen as Cluster
Cluster.print_doc_commands()

Package fluiddoc: helping to build nice web documentations

import fluiddoc
print(fluiddoc.on_rtd)

fluiddoc.mock_modules

from fluiddoc.ipynb_maker import ipynb_to_rst