Asymmetry ========= **Asymmetry** is a Python toolkit and desktop application for muon-spin spectroscopy (μSR): loading raw or reduced data, applying detector grouping and asymmetry transforms, fitting time- and frequency-domain signals, trending fitted parameters, and saving complete analysis sessions for later reuse. .. warning:: **Verify the physics in this documentation against trusted sources.** Asymmetry is in an early, **alpha phase** of development, and this documentation is written alongside it. These pages describe μSR data, fitting-function forms, and analysis workflows to help you use the software — but they are **not a substitute for the primary literature or established analysis tools**. Statements about μSR data, the meaning and parameterisation of fitting models, and the correctness of a given workflow may be incomplete, simplified, or in error. Before relying on any physical interpretation, model definition, or procedure described here, **confirm it against peer-reviewed references and an established μSR tool** (for example WiMDA, Musrfit, or Mantid). Please report anything you find to be inaccurate. Where to start -------------- - :doc:`getting_started/index` — install Asymmetry and make your first asymmetry plot and fit. - :doc:`workflows/index` — complete, worked analyses that demonstrate the graphical interface and the Python API in lock-step. - :doc:`reference/index` — feature-by-feature documentation and the fit-function library. - :doc:`explanation/index` — a μSR primer, the conventions Asymmetry follows, how it compares to other μSR tools, and a :doc:`glossary ` of terms. - :doc:`api/index` — the Python API reference for scripting. - :doc:`contributing` — how to report issues and contribute. .. toctree:: :hidden: :maxdepth: 2 :caption: Contents getting_started/index workflows/index reference/index explanation/index api/index contributing Indices and tables ------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search`