nleis.py

Welcome to nleis.py’s documentation!

nleis.py is a substantial toolbox for impedance.py that enables the analysis of EIS and 2nd-NLEIS.

Contents:

• Getting started with nleis.py
  • Step 1: Installation
  • Step 2: Import your data
  • Step 3: Process your data
  • Step 4: Define your model
  • Step 5: Fit to data
  • Step 6: Visualize and print the results
• Examples
  • Introduction to EIS and 2nd-NLEIS
  • nleis.py Overview and Workflow
  • Graph Based Evaluation and Benchmark
  • Validation of 2nd-NLEIS
  • Parallel: Multistart Fitting Example
  • Parallel: Batch Data Fitting Example
  • Parallel: Batch Model Fitting Example
• Application Notes
• NLEIS
  • EISandNLEIS
  • NLEISCustomCircuit
• Linear and Nonlinear Circuit Elements Pairs
  • A_matrices_TLMn()
  • Kn()
  • RC()
  • RCD()
  • RCDQ()
  • RCDQn()
  • RCDn()
  • RCS()
  • RCSQ()
  • RCSQn()
  • RCSn()
  • RCn()
  • TDC()
  • TDCn()
  • TDP()
  • TDPn()
  • TDS()
  • TDSn()
  • TLM()
  • TLMD()
  • TLMDn()
  • TLMS()
  • TLMSn()
  • TLMn()
  • TP()
  • TPn()
  • d()
  • element()
  • get_element_from_name()
  • mTi()
  • mTiD()
  • mTiDn()
  • mTiS()
  • mTiSn()
  • typeChecker()
• Fitting
  • CircuitGraph
  • buildCircuit()
  • calculateCircuitLength()
  • circuit_fit()
  • extract_circuit_elements()
  • format_parameter_name()
  • mae()
  • mape()
  • seq_fit_param()
  • set_default_bounds()
  • wrapCircuit()
• NLEIS Fitting
  • individual_parameters()
  • simul_fit()
  • wrapCircuit_simul()
  • wrapNeg_log_likelihood()
  • wrappedImpedance()
• Data Processing
  • autolab_fft()
  • convert_to_complex()
  • data_loader()
  • data_truncation()
  • fft_baseline()
  • fft_data()
  • fft_phase_correction()
  • fit_Z1()
  • fit_Z2()
  • plot_fit()
  • plot_freq_domain()
  • thd()
• Data Validation
  • CI_MonteCarlo()
  • MM()
  • MM_conf()
  • MM_cost()
  • cost_max_norm()
  • cost_plot()
• Visualization
  • plot_altair()
  • plot_first()
  • plot_second()
• Parallel
  • batch_data_fit()
  • batch_model_fit()
  • fit_once()
  • multistart_fit()
• Release Notes
  • Version 0.3 (2025-Nov-15)
  • Version 0.2 (2025-02-20)
  • Version 0.1.1 (2025-01-06)
  • Version 0.1 (2024-09-26)

Indices and tables

• Index

• Module Index

• Search Page