semvec/pypi-packages huggingface dataset:
omfit-gks 2020.12.2.22.59
omfit_gks
Requires Python: >=3.6

**GKS** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITgksout

Requires:
=========
* numpy>=1.12
* scipy>=1.0
* uncertainties>=3
* omfit_nc==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITgksout
-----------
N/A
omfit-gingred 2020.12.2.22.59
omfit_gingred
Requires Python: >=3.6

**GINGRED** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITgingred

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITgingred
------------

    OMFIT class used to interface with GINGRED input files

    :param filename: filename passed to OMFITascii class

    :param \**kw: keyword dictionary passed to OMFITascii class
omfit-genray 2020.12.2.22.59
omfit_genray
Requires Python: >=3.6

**GENRAY** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITgenray

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* omas>=0.67.0
* scipy>=1.0
* uncertainties>=3
* omfit_nc==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITgenray
-----------
N/A
omfit-gato 2020.12.2.22.59
omfit_gato
Requires Python: >=3.6

**GATO** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITdskgato
* OMFITo4gta
* OMFITgatohelp
* OMFITgatoDiagnostic

Requires:
=========
* fortranformat>=0.2
* numpy>=1.12
* omas>=0.67.0
* scipy>=1.0
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_json==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITdskgato
------------

    OMFIT class used to interface to equilibria files generated by GATO (.dskgato files)

    NOTE: this object is "READ ONLY", meaning that the changes to the entries of this object will not be saved to a file. Method .save() could be written if becomes necessary

    :param filename: filename passed to OMFITobject class

    :param \**kw: keyword dictionary passed to OMFITobject class
    

OMFITo4gta
----------

    OMFIT class used to interface with GATO o4gta files

    :param filename: filename passed to OMFITascii class

    :param \**kw: keyword dictionary passed to OMFITascii class
    

OMFITgatohelp
-------------

    generates help dictionary for GATO namelist starting from smaphXXX.f

    :param \*args: arguments passed to OMFITascii object

    :param \**kw: keyworkd arguments passed to OMFITascii object

    :return: OMFITjson with parsed help definitions and default values
    

OMFITgatoDiagnostic
-------------------

    OMFIT class used to interface with GATO diagnostic.dat files

    :param filename: filename passed to OMFITascii class

    :param \**kw: keyword dictionary passed to OMFITascii class
omfit-gaprofiles 2020.12.2.22.59
omfit_gaprofiles
Requires Python: >=3.6

**GAPROFILES** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITplasma_cer

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITplasma_cer
---------------

    Process a GAprofiles dplasma_cer_foramt.shot.time file
omfit-gapy 2020.12.2.22.59
omfit_gapy
Requires Python: >=3.6

**GAPY** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITgacode
* OMFITinputprofiles
* OMFITinputgacode

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* omas>=0.67.0
* scipy>=1.0
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITgacode
-----------

    OMFIT class used to interface with GAcode input.XXX files
    This class supports .gen, .extra, .geo, .profiles file

    .plot() method is available for .profiles files

    :param GACODEtype: force 'profiles' parsing input.profiles format or use `None` for autodetection based on file name

    :param filename: filename passed to OMFITascii class

    :param \**kw: keyword dictionary passed to OMFITascii class
    

OMFITinputprofiles
------------------
N/A

OMFITinputgacode
----------------
N/A
omfit-gacode 2020.12.2.22.59
omfit_gacode
Requires Python: >=3.6

**GACODE** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITgacode
* OMFITtgyro
* OMFITgyro
* OMFITcgyro
* OMFITneo
* copy_gacode_module_settings

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* omas>=0.67.0
* scipy>=1.0
* uncertainties>=3
* xarray>=0.10.8
* omfit_base==2020.12.2.22.59
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_gapy==2020.12.2.22.59
* omfit_json==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITgacode
-----------

    OMFIT class used to interface with GAcode input.XXX files
    This class supports .gen, .extra, .geo, .profiles file

    .plot() method is available for .profiles files

    :param GACODEtype: force 'profiles' parsing input.profiles format or use `None` for autodetection based on file name

    :param filename: filename passed to OMFITascii class

    :param \**kw: keyword dictionary passed to OMFITascii class
    

OMFITtgyro
----------

        Class used to interface with TGYRO results directory

        :param filename: directory where the TGYRO result files are stored.
            The data in this directory will be loaded upon creation of the object.
        

OMFITgyro
---------

        Class used to interface with GYRO results directory

        This class extends the OMFITgyro class with the save/load methods of the OMFITpath class
        so that the save/load carries all the original files from the GYRO output

        :param filename: directory where the GYRO result files are stored.
            The data in this directory will be loaded upon creation of the object.
        :param extra_files: Any extra files that should be downloaded from the remote location
        :param test_mode: Don't raise an exception if out.gyro.t is not present (and abort loading at that point)
        

OMFITcgyro
----------

        Class used to interface with CGYRO results directory

        :param filename: directory where the CGYRO result files are stored.
            The data in this directory will be loaded upon creation of the object.
        :param extra_files: Any extra files that should be downloaded from the remote location
        :param test_mode: Don't raise an exception if out.gyro.t is not present (and abort loading at that point)
        

OMFITneo
--------

        Class used to interface with NEO results directory

        :param filename: directory where the TGYRO result files are stored.
            The data in this directory will be loaded upon creation of the object.
        

copy_gacode_module_settings
---------------------------

        Utility function to sync all GACODE modules to use the same working environment

        :param root: GACODE module to use as template (if None only sets module['SETTINGS']['SETUP']['branch'])
omfit-focus 2020.12.2.22.59
omfit_focus
Requires Python: >=3.6

**FOCUS** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITfocusboundary
* OMFITfocusharmonics
* OMFITcoils
* OMFITfocuscoils

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITfocusboundary
------------------

    OMFITobject used to interface with boundary ascii files used in FOCUS.

    :param filename: filename passed to OMFITascii class

    All additional key word arguments passed to OMFITascii

    

OMFITfocusharmonics
-------------------

    OMFITobject used to interface with harmonics ascii files used in FOCUS.

    :param filename: filename passed to OMFITascii class

    All additional key word arguments passed to OMFITascii

    

OMFITcoils
----------

    OMFITobject used to interface with coils ascii files used in FOCUS and STELLOPT codes.

    :param filename: filename passed to OMFITascii class

    All additional key word arguments passed to OMFITascii

    

OMFITfocuscoils
---------------

    OMFITobject used to interface with focus ascii files used to describe coils in native FOCUS
    decomposition.

    :param filename: filename passed to OMFITascii class

    All additional key word arguments passed to OMFITascii
omfit-fastran 2020.12.2.22.59
omfit_fastran
Requires Python: >=3.6

**FASTRAN** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITfastran

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITfastran
------------
FASTRAN data files
omfit-environment 2020.12.2.22.59
omfit_environment
Requires Python: >=3.6

**ENVIRONMENT** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITenv

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITenv
--------

    This class is used to retrieve and parse environmental variables on a server

    :param server: server from which to retrieve the environmental variables

    :param tunnel: tunnel to reach the server

    :param loadStartupFiles: whether the user startup files should be parsed

    :param string: string to be parsed instead of conneting to a server
omfit-elm 2020.12.2.22.59
omfit_elm
Requires Python: >=3.6

**ELM** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* asym_gauss_smooth
* fft_smooth
* OMFITelm

Requires:
=========
* fortranformat>=0.2
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* omas>=0.67.0
* pyyaml>=3.13
* requests>=2.20
* scipy>=1.0
* uncertainties>=3
* xarray>=0.10.8
* omfit_mds==2020.12.2.22.59
* omfit_data==2020.12.2.22.59
* omfit_rdb==2020.12.2.22.59
* omfit_testing==2020.12.2.22.59
* omfit_github==2020.12.2.22.59
* omfit_eqdsk==2020.12.2.22.59
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_nc==2020.12.2.22.59
* omfit_namelist==2020.12.2.22.59
* omfit_error==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
asym_gauss_smooth
-----------------

    This is a smoothing function with a Gaussian kernel that does not require evenly spaced data and allows the
    Gaussian center to be shifted.

    :param x: array
        Dependent variable

    :param y: array
        Independent variable

    :param s: float
        Sigma of tailing side (same units as x)

    :param lag: float
        Positive values shift the Gaussian kernel back in time to increase weight in the past:
        makes the result laggier. (same units as x)

    :param leading_side_width_factor: float
        The leading side sigma will be this much bigger than the tailing side. Values > 1 increase the weight on
        data from the past, making the signal laggier. (unitless)

    :return: array
        Smoothed version of y
    

fft_smooth
----------

    Smooth by removing part of the spectrum in the frequency domain

    1. FFT
    2. Cut out part of the spectrum above some frequency
    3. Inverse FFT to get back to time domain. The result will be missing some of the high frequency variation.

    :param xx: 1D array
        Independent variable, such as time

    :param yy: 1D array matching length of xx
        Dependent variable

    :param s: float
        Smoothing timescale in units matching xx. The cutoff frequency is cut = 1/(s*pi)

    :return: 1D array matching length of xx
        Smoothed (lowpass) version of yy
    

OMFITelm
--------

    Quickly detect ELMs and run a filter that will tell you which time-slices are okay and which should be rejected
    based on user specifications for ELM phase, etc.
omfit-elite 2020.12.2.22.59
omfit_elite
Requires Python: >=3.6

**ELITE** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITeliteGamma
* OMFITeliteEigenfunction
* OMFITelite2DEigenfunction
* OMFITelitefun2d
* OMFITelitextopsi
* OMFITeliteAggregated
* OMFITeqdat
* OMFITbalstab
* OMFIToutbal

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* uncertainties>=3
* xarray>=0.10.8
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_base==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITeliteGamma
---------------
ELITE growth rates data file (Gamma file)

OMFITeliteEigenfunction
-----------------------
N/A

OMFITelite2DEigenfunction
-------------------------
N/A

OMFITelitefun2d
---------------
N/A

OMFITelitextopsi
----------------
N/A

OMFITeliteAggregated
--------------------
N/A

OMFITeqdat
----------

    OMFIT class used to interface to equilibria files generated by ELITE and BALOO (.dskbal files)

    NOTE: this object is "READ ONLY", meaning that the changes to the entries of this object will not be saved to a file. Method .save() could be written if becomes necessary

    :param filename: filename passed to OMFITobject class

    :param \**kw: keyword dictionary passed to OMFITobject class
    

OMFITbalstab
------------

    OMFIT class used to interface to `balstab` file from BALOO

    NOTE: this object is "READ ONLY", meaning that the changes to the entries of this object will not be saved to a file. Method .save() could be written if becomes necessary

    :param filename: filename passed to OMFITobject class

    :param \**kw: keyword dictionary passed to OMFITobject class
    

OMFIToutbal
-----------

    OMFIT class used to interface to `outbal` file from BALOO

    NOTE: this object is "READ ONLY", meaning that the changes to the entries of this object will not be saved to a file. Method .save() could be written if becomes necessary

    :param filename: filename passed to OMFITobject class

    :param \**kw: keyword dictionary passed to OMFITobject class
omfit-efund 2020.12.2.22.59
omfit_efund
Requires Python: >=3.6

**EFUND** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITmhdin
* OMFITdprobe

Requires:
=========
* fortranformat>=0.2
* numpy>=1.12
* uncertainties>=3
* omfit_namelist==2020.12.2.22.59
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITmhdin
----------
N/A

OMFITdprobe
-----------
N/A
omfit-formatter 2020.12.2.22.59
omfit_formatter
Requires Python: >=3.6

**FORMATTER** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* omfit_formatter
* omfit_file_formatter

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
omfit_formatter
---------------

    Format Python string according to OMFIT style
    Based on BLACK: https://github.com/psf/black with 140 chars
    Equivalent to running: `black -S -l 140 -t py36 filename`

    NOTE: some versions of black has issues when a comma trails a parenthesis
    Version 19.3b0 is ok

    :param content: string with Python code to format

    :return: formatted Python code
             None if nothing changed
             False if formatting was skipped due to an InvalidInput
    

omfit_file_formatter
--------------------

    Format Python file according to OMFIT style
    Based on BLACK: https://github.com/psf/black with 140 chars
    Equivalent to running: `black -S -l 140 -t py36 filename`
    NOTE: style enforcement is skipped for files listed in 'bin/conflict_files_black.json' and 'bin/conflict_files_black_stale.json'.

    :param filename: filename of the Python file to format
        If a directory is passed, then all files ending with .py will be processed

    :param overwrite: overwrite original file or simply return if the file has changed

    :param this_branch: ignore conflicts with this branch

    :param check_conflicts: check for conflicts

    :return: formatted Python code
        None if nothing changed
        False if style enforcement is skipped or the input was invalid
        If a directory, then a dictionary with each processed file as key is returned
omfit-nc 2020.12.2.22.59
omfit_nc
Requires Python: >=3.6

**NC** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITnc
* OMFITncData
* OMFITncDataTmp

Requires:
=========
* numpy>=1.12
* scipy>=1.0
* uncertainties>=3
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITnc
-------

    OMFIT class used to interface with NETCDF files
    This class is based on the netCDF4 library which supports the following file formats:
    'NETCDF4', 'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC', 'NETCDF3_64BIT'
    NOTE: This class constains OMFITncData class objects.

    :param filename: filename passed to OMFITobject class

    :param \**kw: keyword dictionary passed to OMFITobject class and the netCDF4.Dataset() method at loading
    

OMFITncData
-----------

    Class which takes care of converting netCDF variables into SortedDict to be used in OMFIT
    OMFITncData object are intended to be contained in OMFITnc objects

    :param variable:  * if  None then returns
                      * if a netCDF4.Variable object then data is read from that variable
                      * if anything else, this is used as the data
                      * if a string and `filename` is set then this is the name of the variable to read from the file

    :param dimension: * Not used if variable is a netCDF4.Variable object or None
                      * If None, then the dimension of the variable is automatically set
                      * If not None sets the dimension of the variable
                      * Ignored if `filename` is set

    :param dtype: * Not used if variable is a netCDF4.Variable object or None
                  * If None, then the data type of the variable is automatically set
                  * If not None sets the data type of the variable
                  * Ignored if `filename` is set

    :param filename: * this is the filename from which variables will be read
                     * if None then no dynamic loading

    

OMFITncDataTmp
--------------

    Same class as OMFITncData but this type of object
    will not be saved into the NetCDF file. This is useful
    if one wants to create "shadow" NetCDF variables into OMFIT
    without altering the original NetCDF file.
omfit-efitviewer 2020.12.2.22.59
omfit_efitviewer
Requires Python: >=3.6

**EFITVIEWER** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* efitviewer

Requires:
=========
* fortranformat>=0.2
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* omas>=0.67.0
* scipy>=1.0
* uncertainties>=3
* xarray>=0.10.8
* omfit_base==2020.12.2.22.59
* omfit_json==2020.12.2.22.59
* omfit_ascii==2020.12.2.22.59
* omfit_path==2020.12.2.22.59
* omfit_omas_utils==2020.12.2.22.59
* omfit_mds==2020.12.2.22.59
* omfit_data==2020.12.2.22.59
* omfit_eqdsk==2020.12.2.22.59
* omfit_nc==2020.12.2.22.59
* omfit_namelist==2020.12.2.22.59
* omfit_error==2020.12.2.22.59
* omfit_formatter==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
efitviewer
----------
Shortcut for launching efitviewer
omfit-efit 2020.12.2.22.59
omfit_efit
Requires Python: >=3.6

**EFIT** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITefitCDF

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* uncertainties>=3
* omfit_hdf5==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITefitCDF
------------

    class used to interface CDF files generated by EFIT++

    :param filename: filename passed to OMFITascii class

    :param \**kw: keyword dictionary passed to OMFITascii class
omfit-hdf5 2020.12.2.22.59
omfit_hdf5
Requires Python: >=3.6

**HDF5** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFIThdf5raw
* OMFIThdf5
* dict2hdf5

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* uncertainties>=3
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFIThdf5raw
------------

    OMFIT class that exposes directly the h5py.File class
    

OMFIThdf5
---------

    OMFIT class that translates HDF5 file to python dictionary
    At this point this class is read only. Changes made to the
    its content will not be reflected to the HDF5 file.
    

dict2hdf5
---------

    Save hierarchy of dictionaries containing np-compatible objects to hdf5 file

    :param filename: hdf5 file to save to

    :param dictin: input dictionary

    :param groupname: group to save the data in

    :param recursive: traverse the dictionary

    :param lists_as_dicts: convert lists to dictionaries with integer strings

    :param compression: gzip compression level
omfit-dmp 2020.12.2.22.59
omfit_dmp
Requires Python: >=3.6

**DMP** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* figures_dmp
* OMFITdmp

Requires:
=========
* matplotlib>=3.1,!=3.2.1,!=3.2.2
* numpy>=1.12
* uncertainties>=3
* omfit_hdf5==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
figures_dmp
-----------
dict() -> new empty dictionary
dict(mapping) -> new dictionary initialized from a mapping object's
    (key, value) pairs
dict(iterable) -> new dictionary initialized as if via:
    d = {}
    for k, v in iterable:
        d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs
    in the keyword argument list.  For example:  dict(one=1, two=2)

OMFITdmp
--------

    Class to satisfy DoE Data Managment Plan that requires the data used in a publication figure to be made available
omfit-dir 2020.12.2.22.59
omfit_dir
Requires Python: >=3.6

**DIR** files used as part of the OMFIT project: https://omfit.io/

Provides:
=========
* OMFITdir

Requires:
=========
* numpy>=1.12
* uncertainties>=3
* omfit_path==2020.12.2.22.59
* omfit_ascii==2020.12.2.22.59
* omfit_commonclasses==2020.12.2.22.59

Authors:
=========
https://omfit.io/contributors.html

Documentation:
==============
OMFITdir
--------

    OMFIT class used to interface with directories

    :param filename: directory path passed to OMFITobject class

    :param extensions: dictionary mapping filename expression to OMFIT classes, for example: {'*.dat': 'OMFITnamelist', '*.xml': 'OMFITxml'}

    :param \**kw: keyword dictionary passed to OMFITobject class