Skip to content

Documentation #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henrikjacobsenfys merged 2 commits into from
Apr 1, 2026
Merged

Documentation #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03fc8b2
Update readme
henrikjacobsenfys Apr 1, 2026
6fdbf2f
update introduction
henrikjacobsenfys Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@
</picture>
</p>

**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.

<!-- HOME REPOSITORY SECTION -->

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
5 changes: 3 additions & 2 deletions docs/docs/introduction/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/docs/user-guide/concept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down
Loading