ClassesΒΆ

OMFIT classes can be installed and used standalone, for example in your (i)Python or jupyter notebooks. To install them from PYPI:

pip install --upgrade omfit_classes

To install them from a personal installation of OMFIT:

cd OMFIT-source/omfit
pip install --user -e .

Following is the list of OMFIT classes and what they provide:

Name

Description

omfit_accome

OMFITaccomeEquilibrium

omfit_ascii

OMFITascii

omfit_asciitable

OMFITasciitable

omfit_aurora

omfit_aurora

omfit_base

_OMFITnoSave, absLocation, all_pylab_imports, askDescription, diffTreeGUI, diffViewer, evalExpr, exportTreeGUI, hasattr, isinstance, ismodule, module_noscratch_deepcopy, module_selective_deepcopy, omfit_log, OMFITcollection, OMFITdictypes, OMFITdictypesStr, OMFITexpression, OMFITexpressionsReturnNone, OMFIThelp, OMFITiterableExpression, OMFITlazyLoad, OMFITlist, OMFITmainSettings, OMFITmcTree, OMFITmodule, OMFITproject, OMFITshotBookmarks, OMFITstorage, OMFITtmp, OMFITtree, OMFITtreeCompressed, OMFITtypes, OMFITtypesStr, relativeLocations, shotBookmarks, type

omfit_bibtex

OMFITbibtex, searchdoi

omfit_boundary

DI_asdex_signal, DI_DTS_signal, DI_file_signal, DI_GW_signal, DI_LP_signal, DI_signal

omfit_bout

boutdata, boututils, OMFITbout

omfit_brainfuse

activateMergeNets, activateNets, activateNetsFile, brainfuse, OMFITbrainfuse

omfit_cdb

OMFITcdb, OMFITcdbValue, pyCDB

omfit_chease

OMFITchease, OMFITcheaseLog

omfit_chombo

OMFITchombo

omfit_cotsim

OMFITcotsim

omfit_csv

OMFITcsv

omfit_ctrl_analysis

auto_scale, ControlAnalysis, ControlQuality, mean_trapz, remove_periodic_noise, sanitize_key, SystemIdentification

omfit_data

DataArray, Dataset, exportDataset, importDataset, OMFITncDataset, OMFITncDynamicDataset, reindex_conv, reindex_interp, smooth_data, split_data

omfit_dir

OMFITdir

omfit_dmp

figures_dmp, OMFITdmp

omfit_efit

OMFITefitCDF

omfit_efitviewer

efitviewer

omfit_efund

OMFITdprobe, OMFITmhdin

omfit_elite

OMFITbalstab, OMFITelite2DEigenfunction, OMFITeliteAggregated, OMFITeliteEigenfunction, OMFITelitefun2d, OMFITeliteGamma, OMFITelitextopsi, OMFITeqdat, OMFIToutbal

omfit_elm

asym_gauss_smooth, fft_smooth, OMFITelm

omfit_environment

OMFITenv

omfit_eqdsk

boundaryShape, BoundaryShape, fluxGeo, fluxSurfaces, fluxSurfaceTraces, from_mds_plus, gEQDSK_COCOS_identify, miller_derived, OMFIT_pcs_shape, OMFITaeqdsk, OMFITeqdsk, OMFITgeqdsk, OMFITkeqdsk, OMFITmeqdsk, OMFITseqdsk, read_basic_eq_from_mds, read_basic_eq_from_toksearch, rz_miller, x_point_quick_search, x_point_search

omfit_error

OMFITerror, OMFITexpressionError, OMFITobjectError

omfit_fastran

OMFITfastran

omfit_focus

OMFITcoils, OMFITfocusboundary, OMFITfocuscoils, OMFITfocusharmonics

omfit_formatter

omfit_file_formatter, omfit_formatter

omfit_gacode

copy_gacode_module_settings, OMFITcgyro, OMFITgacode, OMFITgyro, OMFITneo, OMFITtgyro

omfit_gaprofiles

OMFITplasma_cer

omfit_gapy

OMFITgacode, OMFITinputgacode, OMFITinputprofiles

omfit_gato

OMFITdskgato, OMFITgatoDiagnostic, OMFITgatohelp, OMFITo4gta

omfit_genray

OMFITgenray

omfit_gingred

OMFITgingred

omfit_github

convert_gh_time_str_datetime, delete_matching_gh_comments, edit_github_comment, find_gh_comments, get_gh_remote_org_repo_branch, get_git_branch_info, get_OMFIT_GitHub_token, get_pull_request_number, OMFITgithub_paged_fetcher, on_latest_gh_commit, post_comment_to_github, set_gh_status, set_OMFIT_GitHub_token

omfit_gks

OMFITgksout

omfit_gnuplot

OMFITgnuplot

omfit_google_sheet

OMFITexperimentTable, OMFITgoogleSheet

omfit_gpec

OMFITGPECascii, OMFITGPECbin, OMFITGPECcoils, OMFITGPECnc, OMFITldpi

omfit_gptools

gptools

omfit_harvest

ddb_float, dynamo_to_S3, harvest_nc, harvest_send, OMFITharvest, OMFITharvestS3, upload_harvestS3pickle

omfit_hdf5

dict2hdf5, OMFIThdf5, OMFIThdf5raw

omfit_helena

OMFIThelena, OMFIThelenainput, OMFIThelenaout, OMFITmishkamap

omfit_idl

OMFITidl

omfit_idlSav

OMFITidlSav

omfit_ini

OMFITini, OMFITiniSection

omfit_interface

interface, OMFITinterface

omfit_ionorb

OMFITionorbBirth, OMFITionorbConfig, OMFITionorbFull, OMFITionorbHits

omfit_jsolver

OMFITjsolver

omfit_json

OMFITjson, OMFITsettings, SettingsName

omfit_kepler

OMFITkeplerParams

omfit_latex

OMFITlatex

omfit_mars

OMFITmars, OMFITmarsProfile, OMFITnColumns

omfit_matlab

OMFITmatlab

omfit_matrix

OMFITmatrix

omfit_mds

create_model_tree_from_OMFITobject, interpret_signal, MDSplus, MDSplusConnection, OMFITmds, OMFITmdsCache, OMFITmdsConnection, OMFITmdsObjects, OMFITmdsValue, solveMDSserver, translate_MDSserver, tunneled_MDSserver

omfit_namelist

fortran_environment, OMFITfortranNamelist, OMFITnamelist, sparray

omfit_nc

OMFITnc, OMFITncData, OMFITncDataTmp

omfit_nimrod

OMFITnimrod

omfit_oedge

OMFIToedgeInput, OMFIToedgeNC, OMFIToedgeRun

omfit_omas

browse_imas, browse_imas_remote, cocos_transform, CodeParameters, codeparams_xml_load, codeparams_xml_save, define_cocos, del_omas_s3, different_ods, get_actor_io_ids, identify_cocos, imas_json_dir, imas_versions, IMAS_versions, iter_scenario_summary_remote, latexit, list_omas_s3, load_omas_ascii, load_omas_ds, load_omas_dx, load_omas_h5, load_omas_hdc, load_omas_imas, load_omas_imas_remote, load_omas_iter_scenario, load_omas_iter_scenario_remote, load_omas_json, load_omas_mongo, load_omas_nc, load_omas_pkl, load_omas_s3, load_omas_uda_remote, ODC, ODS, ods_2_odx, ods_sample, ODX, odx_2_ods, omas, omas_ascii, omas_cocos, omas_core, omas_ds, omas_environment, omas_h5, omas_hdc, omas_imas, omas_info, omas_info_node, omas_json, omas_mongo, omas_nc, omas_physics, omas_plot, omas_rcparams, omas_s3, omas_sample, omas_service, omas_service_script, omas_setup, omas_structure, omas_symbols, omas_testdir, omas_uda, omas_utils, OMFITiterscenario, OMFITods, os, rcparams_environment, save_omas_ascii, save_omas_ds, save_omas_dx, save_omas_h5, save_omas_hdc, save_omas_imas, save_omas_imas_remote, save_omas_json, save_omas_mongo, save_omas_nc, save_omas_pkl, save_omas_s3, search_in_array_structure, search_ion, socket, sys, through_omas_ascii, through_omas_ds, through_omas_dx, through_omas_h5, through_omas_hdc, through_omas_imas, through_omas_json, through_omas_mongo, through_omas_nc, through_omas_pkl, through_omas_s3, transform_current

omfit_omas_d3d

find_thomson_lens_d3d, setup_bolometer_hardware_description_d3d, setup_charge_exchange_hardware_description_d3d, setup_gas_injection_hardware_description_d3d, setup_interferometer_hardware_description_d3d, setup_langmuir_probes_hardware_description_d3d, setup_pf_active_hardware_description_d3d, setup_thomson_scattering_hardware_description_d3d

omfit_omas_east

east_coords_along_wall, setup_langmuir_probes_hardware_description_east, setup_pf_active_hardware_description_east

omfit_omas_kstar

find_active_kstar_probes, load_data_langmuir_probes_kstar, setup_langmuir_probes_hardware_description_kstar

omfit_omas_utils

add_experiment_info_to_ods, add_generic_OMFIT_info_to_ods, add_hardware_to_ods, classify_ods_eq_topology, ensure_consistent_experiment_info, get_shape_control_points, get_strike_point, make_sample_ods, multi_efit_to_omas, nubeam_to_omas, OmasUtilsBadInput, orthogonal_distance, pf_coils_to_ods, setup_hardware_overlay_cx, setup_magnetics_hardware_description_general, setup_position_control_hardware_description_general, setup_pulse_schedule_hardware_description_general, toray_to_omas, transp_ic_to_omas

omfit_onetwo

OMFIT_dump_psi, OMFITiterdbProfiles, OMFIToutone, OMFITstatefile, ONETWO_beam_params_from_ods

omfit_osborne

NoFitException, OMFITosborneProfile, OMFITpFile

omfit_patch

OMFITpatch, OMFITpatchList, OMFITpatchObject

omfit_path

OMFITpath

omfit_pdb

OMFITpdb

omfit_profiles

OMFITprofiles, OMFITprofilesDynamic

omfit_python

_lock_OMFIT_preferences, _OMFITpython, defaultVars, execGlobLoc, for_all_modules, help, import_all_private, import_mayavi, omfit_pydocs, OMFITconsoleDict, OMFITpythonGUI, OMFITpythonPlot, OMFITpythonTask, OMFITpythonTest, OMFITreloadedDict, OMFITscriptsDict, OMFITworkDir, parallel_environment, threaded_logic

omfit_rabbit

OMFITrabbitBeamin, OMFITrabbitBeamout, OMFITrabbitEq, OMFITrabbitTimetraces

omfit_rdb

available_EFITs, get_rdb_password, OMFITrdb, set_rdb_password, translate_RDBserver

omfit_reviewplus

OMFITreviewplus

omfit_slack

_get_omfit_slack_credential, get_omfit_slack_token, post_to_slack, set_omfit_slack_token

omfit_solps

find_closest_key, OMFITsolps, OMFITsolpsCase, OMFITsolpsNamelist

omfit_spider

OMFITspider_bonfit

omfit_testing

auto_comment_marker, auto_test_mode, clear_old_test_report_comments, get_server_name, manage_tests, OMFITtest, RedirectStdStreams, run_test_outside_framework, setup_warnings, standard_test_keywords

omfit_tglf

OMFITtglf, OMFITtglf_eig_spectrum, OMFITtglf_fluct_spectrum, OMFITtglf_flux_spectrum, OMFITtglf_intensity_spectrum, OMFITtglf_nete_crossphase_spectrum, OMFITtglf_nsts_crossphase_spectrum, OMFITtglf_potential_spectrum, OMFITtglf_wavefunction, sum_ky_spectrum

omfit_thomson

OMFITthomson

omfit_timcon

OMFITtimcon

omfit_toksearch

OMFITtoksearch, TKS_Aligner, TKS_MdsSignal, TKS_OMFITLoader, TKS_PtDataSignal

omfit_toq

OMFITdskeqdata, OMFITtoqProfiles

omfit_transp

check_TRANSP_run, next_available_TRANSP_runid, OMFITfbm, OMFITplasmastate, OMFITtranspData, OMFITtranspMultigraph, OMFITtranspNamelist, OMFITtranspOutput, wait_TRANSP_run

omfit_trip3d

OMFITtrip3Dcoil, OMFITtrip3Dhits, OMFITtrip3Dlines, OMFITtrip3Dprobeg, OMFITtrip3Dstart

omfit_tsc

OMFITtsc

omfit_uda

OMFITudaConnections, OMFITudaValue

omfit_uedge

OMFITuedge, OMFITuedgeBasisInput, OMFITuedgeInput, uedge_common_map_generator, uedge_common_mapper, uedge_variable

omfit_ufile

OMFITuFile

omfit_weblink

OMFITwebLink, openInBrowser

omfit_xml

OMFITxml