Metadata-Version: 2.4
Name: refl1d
Version: 1.0.0rc1
Summary: Neutron and X-ray reflectometry analysis
Author-email: Paul Kienzle <paul.kienzle@nist.gov>, Brian Maranville <brian.maranville@nist.gov>, Andrew Caruana <andrew.caruana@stfc.uk>, Mathieu Doucet <doucetm@ornl.gov>
License: Copyright 2006-2024 The Refl1D Contributors
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 
        following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following 
        disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 
        disclaimer in the documentation and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote 
        products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, 
        INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
        SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
        WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 
        THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: documentation, https://refl1d.github.io
Project-URL: homepage, https://refl1d.github.io
Project-URL: repository, https://github.com/reflectometry/refl1d
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: bumps==1.0.3
Requires-Dist: matplotlib
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: periodictable
Requires-Dist: scipy
Requires-Dist: orsopy
Provides-Extra: dev
Requires-Dist: ipython; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: nbsphinx; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pydantic; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: sphinx<8.2; extra == "dev"
Requires-Dist: versioningit; extra == "dev"
Provides-Extra: full
Requires-Dist: wxpython; extra == "full"
Requires-Dist: ipython; extra == "full"
Dynamic: license-file

Refl1D
======

Refl1D is a program for analyzing 1-D reflectometry measurements made with
X-ray and neutron beamlines.  The 1-D models give the depth profile for
material scattering density composed of a mixture of flat and continuously
varying freeform layers. With polarized neutron measurements, scientists
can study the sub-surface structure of magnetic samples. The architecture
supports the addition of specialized layer types such as models for the
density distribution of polymer brushes, and volume space modeling for
proteins in bio-membranes. We provide a number of these models as well as
supporting user defined layer types for both structural and magnetic
scattering densities.

Fitting is provided by Bumps, a bayesian uncertainty analysis program.  In
addition to the usual uncertain estimated from the covariance at the best
fit location, Bumps includes a Markov chain Monte Carlo analysis code which
more completely describes the uncertain and correlations between parameters.
Fitting is done in parallel, either using python multiprocessing on a
multicore machine, or using MPI for running on a cluster.

Documentation is available at `<https://refl1d.readthedocs.io>`_. See
`CHANGES.rst <https://github.com/reflectometry/refl1d/blob/master/CHANGES.rst>`_
for details on recent changes. Information on the refl1d release process is in `release notes <release.md>`_.

Use ``pip install refl1d wxpython`` to install in your python environment.

For the windows application, follow the installation instructions on the
`latest release <https://github.com/reflectometry/refl1d/releases/latest>`_
page.  (For the latest bleeding-edge build, see the 
`unstable release <https://github.com/reflectometry/refl1d/releases/tag/sid>`_)

Submit requests and pull requests to the project
`git pages <https://github.com/reflectometry/refl1d>`_

|CI| |RTD| |DOI|

.. |CI| image:: https://github.com/reflectometry/refl1d/actions/workflows/test.yml/badge.svg
   :alt: Build status
   :target: https://github.com/reflectometry/refl1d/actions

.. |DOI| image:: https://zenodo.org/badge/1757015.svg
   :alt: DOI tag
   :target: https://zenodo.org/doi/10.5281/zenodo.1249715

.. |RTD| image:: https://readthedocs.org/projects/refl1d/badge/?version=latest
   :alt: Documentation status
   :target: https://refl1d.readthedocs.io/en/latest
