SciTeX

Getting Started

  • Module Overview
    • Session Decorator (@stx.session)
      • Basic Usage
      • How It Works
      • Output Directory Structure
      • Injected Parameters
      • CONFIG Object
      • Decorator Options
      • Best Practices
      • API Reference
    • IO Module (stx.io)
      • Quick Reference
      • Supported Formats
      • Figure Saving
      • Provenance Tracking
      • Other Functions
      • API Reference
    • Config Module (stx.config)
      • Priority Resolution
      • Quick Reference
      • YAML Configuration
      • Key Classes
      • Path Management
      • Utility Functions
      • API Reference
    • Logging Module (stx.logging)
      • Quick Reference
      • Log Levels
      • Warning Categories
      • Exception Hierarchy
      • Stream Redirection
      • API Reference
    • Repro Module (stx.repro)
      • Quick Reference
      • RandomStateManager
      • Available Functions
      • API Reference
    • Clew Module (stx.clew)
      • How It Works
      • CLI Commands
      • Verification Levels
      • Dependency Chains
      • Verification Statuses
      • Key Functions
      • API Reference
    • Stats Module (stx.stats)
      • Quick Reference
      • Available Tests
      • Seaborn-Style Data Parameter
      • Test Recommendation
      • Output Formats
      • Descriptive Statistics
      • Multiple Comparison Correction
      • Post-hoc Tests
      • API Reference
    • PLT Module (stx.plt)
      • Quick Reference
      • Plot Types (47)
      • MM-Based Layout
      • Axis Helpers
      • Figure Composition
      • Statistical Annotations
      • Reproducible Figures
      • Style Presets
      • API Reference
    • DSP Module (stx.dsp)
      • Quick Reference
      • Available Functions
      • API Reference
    • Diagram Module (stx.diagram)
      • Quick Reference
      • YAML Specification
      • Node Shapes
      • Node Emphasis
      • Diagram Types
      • Paper Modes
      • Backends
      • API Reference
    • canvas Module (stx.canvas)
    • Scholar Module (stx.scholar)
      • Quick Reference
      • CLI Usage
      • Data Sources
      • Key Classes
      • Paper Metadata
      • Filtering and Sorting
      • Project Organization
      • Storage Architecture
      • API Reference
    • Writer Module (stx.writer)
      • Quick Reference
      • CLI Usage
      • Project Structure
      • Key Classes
      • Document Management
      • Writing Guidelines
      • Compilation Options
      • API Reference
    • notebook Module (stx.notebook)
    • AI Module (stx.ai)
      • Quick Reference
      • Training
      • Classification
      • Metrics
      • Visualization
      • Other
      • API Reference
    • NN Module (stx.nn)
      • Quick Reference
      • Signal Processing Layers
      • Channel Manipulation
      • Attention & Shape
      • Architectures
      • API Reference
    • torch Module (stx.torch)
    • cv Module (stx.cv)
    • benchmark Module (stx.benchmark)
    • PD Module (stx.pd)
      • Quick Reference
      • Available Functions
      • API Reference
    • db Module (stx.db)
    • dataset Module (stx.dataset)
    • schema Module (stx.schema)
    • app Module (stx.app)
    • cloud Module (stx.cloud)
    • container Module (stx.container)
    • tunnel Module (stx.tunnel)
    • cli Module (stx.cli)
    • browser Module (stx.browser)
    • capture Module (stx.capture)
    • audio Module (stx.audio)
    • notify Module (stx.notify)
    • social Module (stx.social)
    • Gen Module (stx.gen)
      • Quick Reference
      • API Reference
    • Template Module (stx.template)
      • Project Templates
      • Git Strategies
      • Code Templates
      • Python API
      • API Reference
    • Decorators Module (stx.decorators)
      • Quick Reference
      • Type Conversion
      • Batch Processing
      • Caching
      • Utilities
      • Auto-Ordering
      • API Reference
    • Introspect Module (stx.introspect)
      • Quick Reference
      • IPython-Style Shortcuts
      • Documentation
      • Type Analysis
      • Code Analysis
      • API Tree
      • API Reference
    • str Module (stx.str)
    • dict Module (stx.dict)
    • path Module (stx.path)
    • os Module (stx.os)
    • sh Module (stx.sh)
    • git Module (stx.git)
    • parallel Module (stx.parallel)
    • linalg Module (stx.linalg)
    • datetime Module (stx.datetime)
    • types Module (stx.types)
    • rng Module (stx.rng)
    • context Module (stx.context)
    • resource Module (stx.resource)
    • utils Module (stx.utils)
    • etc Module (stx.etc)
    • web Module (stx.web)
    • msword Module (stx.msword)
    • tex Module (stx.tex)
    • bridge Module (stx.bridge)
    • compat Module (stx.compat)
    • module Module (stx.module)
    • gists Module (stx.gists)
    • media Module (stx.media)
    • security Module (stx.security)
    • ui Module (stx.ui)
    • dev Module (stx.dev)
    • audit Module (stx.audit)
    • events Module (stx.events)
    • project Module (stx.project)
  • Installation
    • Requirements
    • Core Install
    • Recommended: Install Everything
    • Research Workflow
    • Per-Module Extras
    • Development Install
      • Using uv (recommended)
    • Verifying the Installation
  • Quick Start
    • Three Interfaces
      • Python API
      • CLI Commands
      • MCP Tools (120+ tools for AI agents)
    • Complete Example
    • Next Steps
  • Core Concepts
    • Research Workflow
    • Architecture
    • The Session Model
    • Universal I/O
    • Provenance Tracking (Clew)
    • Configuration
    • Best Practices
  • Plot Gallery
    • Line Plots
    • Statistical Plots
    • Distribution Plots
    • Categorical Plots
    • Scatter Plots
    • Heatmaps and Grids
    • Area Plots
    • Special Plots
    • Contour and Vector Plots

API Reference

  • API Reference
    • scitex.session API Reference
      • start()
      • close()
      • running2finished()
      • session()
      • run()
      • SessionManager
        • SessionManager.create_session()
        • SessionManager.close_session()
        • SessionManager.get_active_sessions()
        • SessionManager.get_session()
        • SessionManager.list_sessions()
      • archive_session_dir()
      • restore_session_archive()
      • archive_existing()
      • restore_existing()
    • scitex.io API Reference
      • Functionalities
      • IO
      • Dependencies
      • register_saver()
      • register_loader()
      • get_saver()
      • get_loader()
      • list_formats()
      • unregister_saver()
      • unregister_loader()
      • save()
      • load()
      • load_configs()
      • glob()
      • parse_glob()
      • reload()
      • flush()
      • cache()
      • configure_cache()
      • get_cache_info()
      • clear_load_cache()
      • DotDict
        • DotDict.get()
        • DotDict.to_dict()
        • DotDict.keys()
        • DotDict.values()
        • DotDict.items()
        • DotDict.update()
        • DotDict.setdefault()
        • DotDict.pop()
        • DotDict.copy()
      • register_post_save_hook()
      • register_post_load_hook()
      • H5Explorer
        • H5Explorer.__init__()
        • H5Explorer.__enter__()
        • H5Explorer.__exit__()
        • H5Explorer.close()
        • H5Explorer.explore()
        • H5Explorer.show()
        • H5Explorer.keys()
        • H5Explorer.load()
        • H5Explorer.get()
        • H5Explorer.get_info()
        • H5Explorer.find()
        • H5Explorer.get_shape()
        • H5Explorer.get_dtype()
      • explore_h5()
      • has_h5_key()
      • save_image()
      • save_optuna_study_as_csv_and_pngs()
      • json2md()
      • embed_metadata()
      • read_metadata()
      • has_metadata()
    • scitex.config API Reference
      • ScitexConfig
        • ScitexConfig.__init__()
        • ScitexConfig.get()
        • ScitexConfig.resolve()
        • ScitexConfig.get_nested()
        • ScitexConfig.config_path
        • ScitexConfig.raw
        • ScitexConfig.flat
        • ScitexConfig.print()
      • get_config()
      • load_yaml()
      • ScitexPaths
        • ScitexPaths.__init__()
        • ScitexPaths.base
        • ScitexPaths.logs
        • ScitexPaths.cache
        • ScitexPaths.capture
        • ScitexPaths.screenshots
        • ScitexPaths.rng
        • ScitexPaths.browser
        • ScitexPaths.browser_screenshots
        • ScitexPaths.browser_sessions
        • ScitexPaths.browser_persistent
        • ScitexPaths.test_monitor
        • ScitexPaths.function_cache
        • ScitexPaths.impact_factor_cache
        • ScitexPaths.openathens_cache
        • ScitexPaths.scholar
        • ScitexPaths.scholar_cache
        • ScitexPaths.scholar_library
        • ScitexPaths.writer
        • ScitexPaths.resolve()
        • ScitexPaths.ensure_dir()
        • ScitexPaths.ensure_all()
        • ScitexPaths.list_all()
      • get_paths()
      • PriorityConfig
        • PriorityConfig.SENSITIVE_EXPRESSIONS
        • PriorityConfig.__init__()
        • PriorityConfig.get()
        • PriorityConfig.resolve()
        • PriorityConfig.print_resolutions()
        • PriorityConfig.clear_log()
      • get_scitex_dir()
      • load_dotenv()
      • parse_src_file()
      • load_env_from_path()
      • load_scitex_env()
    • scitex.logging API Reference
      • getLogger()
      • configure()
      • set_level()
      • get_level()
      • enable_file_logging()
      • is_file_logging_enabled()
      • get_log_path()
      • Tee
        • Tee.write()
        • Tee.flush()
        • Tee.isatty()
        • Tee.fileno()
        • Tee.buffer
        • Tee.close()
      • tee()
      • log_to_file()
      • SciTeXWarning
      • UnitWarning
      • StyleWarning
      • SciTeXDeprecationWarning
      • PerformanceWarning
      • DataLossWarning
      • warn()
      • filterwarnings()
      • resetwarnings()
      • warn_deprecated()
      • warn_performance()
      • warn_data_loss()
      • SciTeXError
        • SciTeXError.__init__()
      • ConfigurationError
      • ConfigFileNotFoundError
      • ConfigKeyError
      • IOError
      • FileFormatError
      • SaveError
      • LoadError
      • ScholarError
      • SearchError
      • EnrichmentError
      • PDFDownloadError
      • DOIResolutionError
      • PDFExtractionError
      • BibTeXEnrichmentError
      • TranslatorError
      • AuthenticationError
      • PlottingError
      • FigureNotFoundError
      • AxisError
      • DataError
      • ShapeError
      • DTypeError
      • PathError
      • InvalidPathError
      • PathNotFoundError
      • TemplateError
      • TemplateViolationError
      • NNError
      • ModelError
      • StatsError
      • TestError
      • check_path()
      • check_file_exists()
      • check_shape_compatibility()
    • scitex.repro API Reference
      • gen_ID()
      • gen_id()
      • gen_timestamp()
      • timestamp()
      • hash_array()
      • RandomStateManager
        • RandomStateManager.__init__()
        • RandomStateManager.get_np_generator()
        • RandomStateManager.__call__()
        • RandomStateManager.verify()
        • RandomStateManager.checkpoint()
        • RandomStateManager.restore()
        • RandomStateManager.temporary_seed()
        • RandomStateManager.get_sklearn_random_state()
        • RandomStateManager.get_torch_generator()
        • RandomStateManager.get_generator()
        • RandomStateManager.clear_cache()
      • get()
      • reset()
      • fix_seeds()
    • scitex.clew API Reference
      • status()
      • run()
      • chain()
      • dag()
      • rerun()
      • rerun_dag()
      • rerun_claims()
      • list_runs()
      • stats()
      • add_claim()
      • list_claims()
      • verify_claim()
      • export_claims_json()
      • register_intermediate()
      • stamp()
      • list_stamps()
      • check_stamp()
      • hash_file()
      • hash_directory()
      • mermaid()
      • init_examples()
      • on_session_start()
      • on_session_close()
    • scitex.stats API Reference
      • Functionalities
      • IO
      • Dependencies
      • run_test()
      • available_tests()
      • describe()
      • to_json_safe()
      • Stats
        • Stats.analyses
        • Stats.software
        • Stats.schema_name
        • Stats.schema_version
        • Stats.to_dict()
        • Stats.to_json()
        • Stats.from_dict()
        • Stats.from_json()
      • test_result_to_stats()
      • save_stats()
      • load_stats()
      • to_figrecipe()
      • annotate()
      • load_and_annotate()
      • StatContext
        • StatContext.n_groups
        • StatContext.sample_sizes
        • StatContext.outcome_type
        • StatContext.design
        • StatContext.paired
        • StatContext.has_control_group
        • StatContext.n_factors
        • StatContext.normality_ok
        • StatContext.variance_homogeneity_ok
        • StatContext.missing_allowed
        • StatContext.group_names
        • StatContext.control_group_name
        • StatContext.__post_init__()
        • StatContext.n_total
        • StatContext.min_n_per_group
        • StatContext.effective_paired
        • StatContext.to_dict()
        • StatContext.from_dict()
        • StatContext.from_data()
      • TestRule
        • TestRule.name
        • TestRule.family
        • TestRule.min_groups
        • TestRule.max_groups
        • TestRule.outcome_types
        • TestRule.supports_paired
        • TestRule.supports_unpaired
        • TestRule.design_allowed
        • TestRule.requires_control_group
        • TestRule.min_n_total
        • TestRule.min_n_per_group
        • TestRule.needs_normality
        • TestRule.needs_equal_variance
        • TestRule.min_factors
        • TestRule.max_factors
        • TestRule.priority
        • TestRule.description
      • StatStyle
        • StatStyle.id
        • StatStyle.label
        • StatStyle.target
        • StatStyle.stat_symbol_format
        • StatStyle.p_format
        • StatStyle.alpha_thresholds
        • StatStyle.effect_label_format
        • StatStyle.n_format
        • StatStyle.decimal_places_p
        • StatStyle.decimal_places_stat
        • StatStyle.decimal_places_effect
        • StatStyle.format_stat()
        • StatStyle.format_p()
        • StatStyle.format_effect()
        • StatStyle.format_n()
        • StatStyle.p_to_stars()
      • recommend_tests()
      • check_applicable()
      • get_stat_style()
      • p_to_stars()
      • test_ttest_ind()
      • test_ttest_rel()
      • test_ttest_1samp()
      • test_anova()
      • test_anova_rm()
      • test_anova_2way()
      • test_brunner_munzel()
      • test_wilcoxon()
      • test_kruskal()
      • test_mannwhitneyu()
      • test_friedman()
      • test_pearson()
      • test_spearman()
      • test_kendall()
      • test_theilsen()
      • test_chi2()
      • test_fisher()
      • test_mcnemar()
      • test_cochran_q()
      • test_shapiro()
      • test_normality()
      • test_ks_1samp()
      • test_ks_2samp()
    • scitex.plt API Reference
      • subplots()
      • figure()
      • save()
      • show()
      • savefig()
      • close()
      • clf()
      • cla()
      • gcf()
      • gca()
      • subplot()
      • subplot2grid()
      • subplot_mosaic()
      • subplots_adjust()
      • tight_layout()
      • suptitle()
      • xlabel()
      • ylabel()
      • title()
      • legend()
      • xlim()
      • ylim()
      • grid()
      • plot()
      • scatter()
      • bar()
      • hist()
      • imshow()
      • contour()
      • contourf()
      • colorbar()
      • axhline()
      • axvline()
      • text()
      • annotate()
      • fill_between()
      • errorbar()
      • boxplot()
      • violinplot()
      • pie()
      • stem()
      • step()
      • stackplot()
      • streamplot()
      • quiver()
      • barbs()
      • hexbin()
      • pcolormesh()
      • tripcolor()
      • tricontour()
      • tricontourf()
      • spy()
      • matshow()
      • specgram()
      • psd()
      • csd()
      • cohere()
      • magnitude_spectrum()
      • angle_spectrum()
      • phase_spectrum()
      • xcorr()
      • acorr()
      • semilogy()
      • semilogx()
      • loglog()
      • polar()
      • rc()
      • rcdefaults()
      • get_cmap()
      • build_spec()
      • build_spec_from_csv()
      • render_spec_to_bytes()
      • termplot()
      • draw_graph()
      • smart_align()
      • align_smart()
      • enable_svg()
      • edit()
      • gui()
      • apply_style()
      • load_style()
      • unload_style()
      • list_presets()
      • compose()
      • crop()
      • Diagram
        • Diagram.add_box()
        • Diagram.add_container()
        • Diagram.add_arrow()
        • Diagram.add_icon()
        • Diagram.validate_containers()
        • Diagram.validate_no_overlap()
        • Diagram.auto_layout()
        • Diagram.render()
        • Diagram.save()
        • Diagram.render_to_file()
        • Diagram.to_dict()
        • Diagram.from_dict()
      • align_panels()
      • distribute_panels()
      • extract_data()
      • get_graph_preset()
      • list_graph_presets()
      • register_graph_preset()
      • info()
      • load()
      • load_bundle()
      • save_bundle()
      • reproduce()
      • reproduce_bundle()
      • validate()
    • scitex.dsp API Reference
    • scitex.diagram API Reference
      • Diagram
        • Diagram.add_box()
        • Diagram.add_container()
        • Diagram.add_arrow()
        • Diagram.add_icon()
        • Diagram.validate_containers()
        • Diagram.validate_no_overlap()
        • Diagram.auto_layout()
        • Diagram.render()
        • Diagram.save()
        • Diagram.render_to_file()
        • Diagram.to_dict()
        • Diagram.from_dict()
      • GraphDiagram
      • DiagramSpec
        • DiagramSpec.type
        • DiagramSpec.title
        • DiagramSpec.paper
        • DiagramSpec.layout
        • DiagramSpec.nodes
        • DiagramSpec.edges
        • DiagramSpec.theme
        • DiagramSpec.from_dict()
      • DiagramType
        • DiagramType.WORKFLOW
        • DiagramType.DECISION
        • DiagramType.PIPELINE
        • DiagramType.HIERARCHY
        • DiagramType.COMPARISON
      • NodeSpec
        • NodeSpec.id
        • NodeSpec.label
        • NodeSpec.shape
        • NodeSpec.emphasis
        • NodeSpec.short_label()
      • EdgeSpec
        • EdgeSpec.source
        • EdgeSpec.target
        • EdgeSpec.label
        • EdgeSpec.style
        • EdgeSpec.arrow
      • PaperConstraints
        • PaperConstraints.column
        • PaperConstraints.max_width_mm
        • PaperConstraints.reading_direction
        • PaperConstraints.mode
        • PaperConstraints.emphasize
        • PaperConstraints.main_flow
        • PaperConstraints.secondary_flow
        • PaperConstraints.return_edges
      • LayoutHints
        • LayoutHints.layers
        • LayoutHints.alignment
        • LayoutHints.layer_gap
        • LayoutHints.node_gap
        • LayoutHints.groups
      • ColumnLayout
        • ColumnLayout.SINGLE
        • ColumnLayout.DOUBLE
      • SpacingLevel
        • SpacingLevel.TIGHT
        • SpacingLevel.COMPACT
        • SpacingLevel.MEDIUM
        • SpacingLevel.LARGE
      • PaperMode
        • PaperMode.DRAFT
        • PaperMode.PUBLICATION
      • compile_to_mermaid()
      • compile_to_graphviz()
      • DiagramPreset
        • DiagramPreset.mermaid_direction
        • DiagramPreset.mermaid_theme
        • DiagramPreset.graphviz_rankdir
        • DiagramPreset.graphviz_ranksep
        • DiagramPreset.graphviz_nodesep
        • DiagramPreset.spacing_map
        • DiagramPreset.mermaid_shapes
        • DiagramPreset.graphviz_shapes
        • DiagramPreset.emphasis_styles
      • get_preset()
      • list_presets()
      • SplitConfig
        • SplitConfig.enabled
        • SplitConfig.max_nodes
        • SplitConfig.strategy
        • SplitConfig.keep_hubs
        • SplitConfig.ghost_style
      • SplitResult
        • SplitResult.figures
        • SplitResult.labels
        • SplitResult.cut_nodes
      • SplitStrategy
        • SplitStrategy.BY_GROUPS
        • SplitStrategy.BY_ARTICULATION
      • get_available_backends()
    • scitex.scholar API Reference
      • Scholar
        • Scholar.name
        • Scholar.__init__()
      • Paper
        • Paper.metadata
        • Paper.container
        • Paper.model_config
        • Paper.model_dump()
        • Paper.from_dict()
        • Paper.to_dict()
        • Paper.detect_open_access()
        • Paper.is_open_access
      • Papers
        • Papers.__init__()
        • Papers.__len__()
        • Papers.__iter__()
        • Papers.__getitem__()
        • Papers.__repr__()
        • Papers.__str__()
        • Papers.__dir__()
        • Papers.papers
        • Papers.append()
        • Papers.extend()
        • Papers.to_list()
        • Papers.filter()
        • Papers.sort_by()
        • Papers.from_bibtex()
        • Papers.save()
        • Papers.to_dict()
        • Papers.to_dataframe()
        • Papers.summary()
      • ScholarConfig
        • ScholarConfig.__init__()
        • ScholarConfig.__getattr__()
        • ScholarConfig.__dir__()
        • ScholarConfig.resolve()
        • ScholarConfig.get()
        • ScholarConfig.print()
        • ScholarConfig.clear_log()
        • ScholarConfig.load_yaml()
        • ScholarConfig.load()
        • ScholarConfig.paths
      • ScholarAuthManager
        • ScholarAuthManager.__init__()
        • ScholarAuthManager.ensure_authenticate_async()
        • ScholarAuthManager.is_authenticate_async()
        • ScholarAuthManager.authenticate_async()
        • ScholarAuthManager.get_auth_headers_async()
        • ScholarAuthManager.get_auth_options()
        • ScholarAuthManager.get_auth_cookies_async()
        • ScholarAuthManager.set_active_provider()
        • ScholarAuthManager.get_active_provider()
        • ScholarAuthManager.logout_async()
        • ScholarAuthManager.list_providers()
      • ScholarBrowserManager
        • ScholarBrowserManager.__init__()
        • ScholarBrowserManager.get_authenticated_browser_and_context_async()
        • ScholarBrowserManager.take_screenshot_async()
        • ScholarBrowserManager.start_periodic_screenshots_async()
        • ScholarBrowserManager.stop_periodic_screenshots_async()
        • ScholarBrowserManager.close()
      • ScholarURLFinder
        • ScholarURLFinder.PAGE_LOAD_TIMEOUT
        • ScholarURLFinder.find_pdf_urls()
      • CitationGraphBuilder
        • CitationGraphBuilder.__init__()
        • CitationGraphBuilder.build()
        • CitationGraphBuilder.build_from_dois()
        • CitationGraphBuilder.build_from_query()
        • CitationGraphBuilder.export_json()
        • CitationGraphBuilder.get_paper_summary()
      • plot_citation_graph()
      • to_bibtex()
      • to_ris()
      • to_endnote()
      • to_text_citation()
      • papers_to_format()
      • generate_cite_key()
      • make_citation_key()
      • from_connected_papers()
      • to_connected_papers()
      • apply_filters()
    • scitex.writer
      • usage()
      • Writer
        • Writer.__init__()
        • Writer.compile_manuscript()
        • Writer.compile_supplementary()
        • Writer.compile_revision()
        • Writer.get_section()
        • Writer.read_section()
        • Writer.write_section()
        • Writer.watch()
        • Writer.get_pdf()
        • Writer.delete()
      • ensure_workspace()
      • gui()
    • scitex.linter
    • scitex.ai API Reference
    • scitex.nn API Reference
    • scitex.template API Reference
    • scitex.decorators API Reference
    • scitex.introspect API Reference
      • q()
      • qq()
      • dir()
      • list_api()
      • get_docstring()
      • get_exports()
      • find_examples()
      • resolve_object()
      • get_type_info()
      • get_class_hierarchy()
      • get_mro()
      • get_type_hints_detailed()
      • get_class_annotations()
      • get_imports()
      • get_dependencies()
      • get_call_graph()
      • get_function_calls()
    • scitex.pd API Reference
    • scitex.gen API Reference
    • scitex.db API Reference
      • PostgreSQL
        • PostgreSQL.__call__()
        • PostgreSQL.summary
      • SQLite3
        • SQLite3.__init__()
        • SQLite3.__enter__()
        • SQLite3.__exit__()
        • SQLite3.__del__()
        • SQLite3.__call__()
        • SQLite3.summary
      • batch_health_check()
      • check_health()
      • delete_duplicates()
      • delete_sqlite3_duplicates()
      • inspect()
    • scitex.dict API Reference
      • DotDict
        • DotDict.get()
        • DotDict.to_dict()
        • DotDict.__str__()
        • DotDict.__repr__()
        • DotDict.pformat()
        • DotDict.__len__()
        • DotDict.keys()
        • DotDict.values()
        • DotDict.items()
        • DotDict.update()
        • DotDict.setdefault()
        • DotDict.pop()
        • DotDict.__contains__()
        • DotDict.__iter__()
        • DotDict.copy()
        • DotDict.__dir__()
        • DotDict.__eq__()
        • DotDict.__ne__()
        • DotDict.__lt__()
        • DotDict.__le__()
        • DotDict.__gt__()
        • DotDict.__ge__()
        • DotDict.__bool__()
      • listed_dict()
      • pop_keys()
      • replace()
      • safe_merge()
      • to_str()
      • flatten()
    • scitex.str API Reference
      • LaTeXFallbackError
      • add_hat_in_latex_style()
      • auto_factor_axis()
      • axis_label()
      • check_latex_capability()
      • check_unit_consistency()
      • clean_path()
      • color_text()
      • ct()
      • decapitalize()
      • disable_latex_fallback()
      • enable_latex_fallback()
      • factor_out_digits()
      • format_axis_label()
      • format_plot_text()
      • format_title()
      • get_fallback_mode()
      • get_latex_status()
      • grep()
      • hat_latex_style()
      • latex_fallback_decorator()
      • latex_style()
      • latex_to_mathtext()
      • latex_to_unicode()
      • mask_api()
      • parse()
      • print_debug()
      • printc()
      • readable_bytes()
      • remove_ansi()
      • replace()
      • reset_latex_cache()
      • safe_add_hat_in_latex_style()
      • safe_latex_render()
      • safe_to_latex_style()
      • scientific_text()
      • search()
      • set_fallback_mode()
      • smart_tick_formatter()
      • squeeze_spaces()
      • title()
      • title_case()
      • to_latex_style()
    • scitex.path API Reference
      • clean()
      • create_relative_symlink()
      • find_dir()
      • find_file()
      • find_git_root()
      • find_latest()
      • fix_broken_symlinks()
      • get_data_path_from_a_package()
      • get_spath()
      • get_this_path()
      • getsize()
      • increment_version()
      • is_symlink()
      • list_symlinks()
      • mk_spath()
      • readlink()
      • resolve_symlinks()
      • split()
      • symlink()
      • this_path()
      • unlink_symlink()
    • scitex.social API Reference
      • Twitter
        • Twitter.platform_name
        • Twitter.MAX_TWEET_LENGTH
        • Twitter.POST_ENDPOINT
        • Twitter.DELETE_ENDPOINT
        • Twitter.ME_ENDPOINT
        • Twitter.USER_TWEETS_ENDPOINT
        • Twitter.USER_MENTIONS_ENDPOINT
        • Twitter.SEARCH_ENDPOINT
        • Twitter.MEDIA_UPLOAD_ENDPOINT
        • Twitter.USER_BY_USERNAME_ENDPOINT
        • Twitter.FOLLOW_ENDPOINT
        • Twitter.UNFOLLOW_ENDPOINT
        • Twitter.validate_credentials()
        • Twitter.validate_read_credentials()
        • Twitter.upload_media()
        • Twitter.post()
        • Twitter.delete()
        • Twitter.post_thread()
        • Twitter.me()
        • Twitter.feed()
        • Twitter.mentions()
        • Twitter.replies()
      • LinkedIn
        • LinkedIn.platform_name
        • LinkedIn.BASE_URL
        • LinkedIn.ME_ENDPOINT
        • LinkedIn.USERINFO_ENDPOINT
        • LinkedIn.UGC_POSTS_ENDPOINT
        • LinkedIn.POSTS_ENDPOINT
        • LinkedIn.SHARES_ENDPOINT
        • LinkedIn.validate_credentials()
        • LinkedIn.post()
        • LinkedIn.delete()
        • LinkedIn.get_token_info()
        • LinkedIn.me()
        • LinkedIn.feed()
      • Reddit
        • Reddit.platform_name
        • Reddit.validate_credentials()
        • Reddit.post()
        • Reddit.delete()
        • Reddit.comment()
        • Reddit.me()
        • Reddit.feed()
        • Reddit.mentions()
        • Reddit.update()
      • Slack
        • Slack.platform_name
        • Slack.API_BASE
        • Slack.POST_MESSAGE_ENDPOINT
        • Slack.DELETE_MESSAGE_ENDPOINT
        • Slack.UPDATE_MESSAGE_ENDPOINT
        • Slack.CONVERSATIONS_HISTORY_ENDPOINT
        • Slack.AUTH_TEST_ENDPOINT
        • Slack.USERS_INFO_ENDPOINT
        • Slack.__init__()
        • Slack.validate_credentials()
        • Slack.post()
        • Slack.delete()
        • Slack.update()
        • Slack.feed()
        • Slack.me()
        • Slack.post_thread()
      • YouTube
        • YouTube.platform_name
        • YouTube.__init__()
        • YouTube.validate_credentials()
        • YouTube.post()
        • YouTube.delete()
        • YouTube.update()
        • YouTube.get_channel_info()
        • YouTube.list_videos()
        • YouTube.me()
        • YouTube.feed()
      • GoogleAnalytics
        • GoogleAnalytics.__init__()
        • GoogleAnalytics.validate_credentials()
        • GoogleAnalytics.track_event()
        • GoogleAnalytics.track_social_post()
        • GoogleAnalytics.track_social_delete()
        • GoogleAnalytics.get_realtime_users()
        • GoogleAnalytics.get_page_views()
        • GoogleAnalytics.get_traffic_sources()
      • move_to_scheduled()
      • move_to_posted()
      • ensure_project_dirs()
SciTeX
  • API Reference
  • Edit on GitHub

API Reference

Auto-generated API documentation for all SciTeX modules.

  • scitex.session API Reference
  • scitex.io API Reference
  • scitex.config API Reference
  • scitex.logging API Reference
  • scitex.repro API Reference
  • scitex.clew API Reference
  • scitex.stats API Reference
  • scitex.plt API Reference
  • scitex.dsp API Reference
  • scitex.diagram API Reference
  • scitex.scholar API Reference
  • scitex.writer
  • scitex.linter
  • scitex.ai API Reference
  • scitex.nn API Reference
  • scitex.template API Reference
  • scitex.decorators API Reference
  • scitex.introspect API Reference
  • scitex.pd API Reference
  • scitex.gen API Reference
  • scitex.db API Reference
  • scitex.dict API Reference
  • scitex.str API Reference
  • scitex.path API Reference
  • scitex.social API Reference
Previous Next

© Copyright 2024-2026, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.