diff --git a/README.md b/README.md index 065db358..83a9d7c8 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,9 @@

-**EasyDynamics** is a software for plotting and fitting QENS and INS -powder data. +**EasyDynamics** is a software package for plotting and fitting neutron +spectroscopy data (QENS and INS), mainly dedicated to amorphous +materials and crystalline powders. diff --git a/docs/docs/index.md b/docs/docs/index.md index d683b5b9..f3164718 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,6 +1,6 @@ ![](assets/images/logo_dark.svg#gh-dark-mode-only)![](assets/images/logo_light.svg#gh-light-mode-only) -# QENS data analysis +# Neutron spectroscopy data analysis Here is a brief overview of the main documentation sections: diff --git a/docs/docs/introduction/index.md b/docs/docs/introduction/index.md index d749ae2a..87018550 100644 --- a/docs/docs/introduction/index.md +++ b/docs/docs/introduction/index.md @@ -6,8 +6,9 @@ icon: material/information-slab-circle ## Description -**EasyDynamics** is a software for plotting and fitting QENS and INS -powder data. +**EasyDynamics** is a software package for plotting and fitting neutron +spectroscopy data (QENS and INS), mainly dedicated to amorphous +materials and crystalline powders **EasyDynamics** is developed both as a Python library and as a cross-platform desktop application. diff --git a/docs/docs/user-guide/concept.md b/docs/docs/user-guide/concept.md index 4bb3bff4..17014b92 100644 --- a/docs/docs/user-guide/concept.md +++ b/docs/docs/user-guide/concept.md @@ -1,5 +1,5 @@ -The goal of EasyDynamics is to make it easy to fit QENS and powder INS -data. +EasyDynamics is a a fitting tool for neutron spectroscopy, mainly +dedicated to amorphous materials and crystalline powders. The fit is carried out by an `Analysis` object, which contains an `Experiment` that contains the data, a `SampleModel` that describes the @@ -44,10 +44,10 @@ like this: ```python gaussian = Gaussian() -gaussian.area=2.0 -gaussian.area.fixed=True -gaussian.width.fixed=False -gaussian.width.min=0.5 +gaussian.area = 2.0 +gaussian.area.fixed = True +gaussian.width.fixed = False +gaussian.width.min = 0.5 ``` And so on.