Welcome to nres's documentation!
================================

nres (pronounced N-res) is a simple yet powerful package for fitting neutron resonances. It allows quick and easy quantitative fitting of total cross-section for neutron absorption resonances transmission spectrum in the epithermal and fast energy regions.

Features
--------
- Flexible and simple way to generate and combine cross-sections from different isotopic materials.
- Built-in database of many useful materials and elements.
- Cross-sections taken from ENDF8.0.
- Built on `lmfit` for intuitive and powerful fit exploration.
- Python API leveraging popular libraries like `numpy` and `pandas`.
- Methods to define response functions and background functions.
- Plotting utilities for concise result visualization.
- Fast cross-section integration and convolution with response function using C++ core code.
- **NEW in v0.4**: Grouped data support for imaging detectors and multi-sample measurements.
- **NEW in v0.4**: Advanced rebinning capabilities for time-of-flight data.
- **NEW in v0.4**: Parallel fitting with progress tracking and memory management.
- **NEW in v0.4**: Save/load functionality for models and results.
- **NEW in v0.4**: Enhanced visualization with transmission maps and multi-parameter plots.

Installation
------------
To install from source, you can clone the repository and install it using pip:

.. code-block:: bash

    git clone https://github.com/TsvikiHirsh/nres
    cd nres
    pip install .

Basic Usage
-----------
Here's a quick example of how to use `nres`:

.. code-block:: python

    # Import nres
    import nres

    # Define material
    Si = nres.CrossSection("Silicon")

    # Load data
    data = nres.Data.from_transmission("silicon.dat")

    # Define model
    model = nres.TransmissionModel(Si, vary_background=True)

    # Fit using lmfit
    result = model.fit(data, emin=0.4e6, emax=1.7e6)

    # Plot fit results
    result.plot()

.. image:: https://github.com/TsvikiHirsh/nres/raw/master/docs/images/silicon_fit.png
   :alt: Fit results
   :align: center
   :width: 600px

For more detailed examples and advanced usage, please refer to our Jupyter `notebook demo <https://github.com/TsvikiHirsh/nres/blob/master/notebooks/nres_demo.ipynb>`_.

Contributing
------------
See `CONTRIBUTING.md <https://github.com/TsvikiHirsh/nres/blob/master/CONTRIBUTING.md>`_ for instructions on how to contribute.

License
-------
Distributed under the terms of the `MIT license <https://github.com/TsvikiHirsh/nres/blob/master/LICENSE.md>`_.

Contact
-------
For questions, issues, or contributions, please visit the `GitHub repository <https://github.com/TsvikiHirsh/nres>`_.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   cross_section_usage
   data_usage
   models_physics
   models_usage
   modules
   cross_section
   data
   response
   models

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`