Skip to content

Commit

Permalink
Remove part of docstring to test sphinx issue
Browse files Browse the repository at this point in the history
  • Loading branch information
observingClouds authored Dec 14, 2023
1 parent ecfef1f commit 38abccb
Showing 1 changed file with 0 additions and 21 deletions.
21 changes: 0 additions & 21 deletions xbitinfo/xbitinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -492,27 +492,6 @@ def get_prefect_flow(paths=[]):
3. Apply bitrounding with :py:func:`xbitinfo.bitround.xr_bitround`
4. Save as compressed netcdf with :py:class:`xbitinfo.save_compressed.ToCompressed_Netcdf`
Many parameters can be changed when running the flow ``flow.run(parameters=dict(chunk="auto"))``:
- paths: list of paths
Paths to be bitrounded
- analyse_paths: str or int
Which paths to be passed to :py:func:`xbitinfo.xbitinfo.get_bitinformation`. Choose from ``["first_last", "all", int]``, where int is interpreted as stride, i.e. paths[::stride]. Defaults to ``"first"``.
- enforce_dtype : str or None
Enforce dtype for all variables. Currently, :py:func:`xbitinfo.xbitinfo.get_bitinformation` fails for different dtypes in variables. Do nothing if ``None``. Defaults to ``None``.
- label : see :py:func:`xbitinfo.xbitinfo.get_bitinformation`
- dim/axis : see :py:func:`xbitinfo.xbitinfo.get_bitinformation`
- inflevel : see :py:func:`xbitinfo.xbitinfo.get_keepbits`
- non_negative_keepbits : bool
Set negative keepbits from :py:func:`xbitinfo.xbitinfo.get_keepbits` to ``0``. Required when using :py:func:`xbitinfo.bitround.xr_bitround`. Defaults to True.
- chunks : see :py:meth:`xarray.open_mfdataset`. Note that with ``chunks=None``, ``dask`` is not used for I/O and the flow is still parallelized when using ``DaskExecutor``.
- bitround_in_julia : bool
Use :py:func:`xbitinfo.bitround.jl_bitround` instead of :py:func:`xbitinfo.bitround.xr_bitround`. Both should yield identical results. Defaults to ``False``.
- overwrite : bool
Whether to overwrite bitrounded netcdf files. ``False`` (default) skips existing files.
- complevel : see to_compressed_netcdf, defaults to ``7``.
- rename : list
Replace mapping for paths towards new_path of bitrounded file, i.e. ``replace=[".nc", "_bitrounded_compressed.nc"]``
Parameters
------
paths : list
Expand Down

0 comments on commit 38abccb

Please sign in to comment.