Skip to content

Conversation

@mEngstroem
Copy link
Contributor

Updated tutorials, restructured index to EasyDiffraction-layout, moved dictionary and calculator into 'tutorials.rst'

…d dictionary and calculator into 'tutorials.rst'
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pull request does not contain a valid label. Please add one of the following labels: ['chore', 'fix', 'bugfix', 'bug', 'enhancement', 'feature', 'dependencies', 'documentation']

@damskii9992 damskii9992 added the [scope] documentation Documentation only changes (major.minor.patch-EXTENSION) label Feb 17, 2025
Copy link

@elindgren elindgren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finished first part of my review, will take a look at the notebooks next. As an "outsider", I think the overall changes makes sense. I just had a few nitpicks/questions.

@elindgren
Copy link

elindgren commented Feb 19, 2025

I had a look at the notebooks, and I see that most of them have been migrated as-is. Looks good to me!

Another point of feedback I had could maybe be to rename the "Usage" tab to "Getting started", and include a minimum example usage of the package (beyond importing it) if possible. Maybe something like

import easyreflectometry
from easyreflectometry.sample import Material, Layer
from easyreflectometry.model import Model
from easyreflectometry.fitting import MultiFitter
from easyreflectometry.plot import plot

# Define your Material
material = Material(...)

# Create a Layer
layer = Layer(material=material, ...)

# Make a Sample out of the Layer
sample = Sample(layer, ...)

# Define a Model of the experiment
model = Model(
    sample=sample,
    scale=1,
    background=1e-6,
    ...
)

# Set parameter bounds for fit
...

# Perform the fit and plot
fitter = MultiFitter(model)
analysed = fitter.fit(data)

plot(analysed)

Show the end user that it's really easy using EasyReflectometry! 🌈

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@henrikjacobsenfys
Copy link
Member

I removed output from the Jupyter notebooks. I think it's ready for merging, I can do that tomorrow.

@henrikjacobsenfys henrikjacobsenfys merged commit f9fc7ef into easyscience:develop Mar 7, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[scope] documentation Documentation only changes (major.minor.patch-EXTENSION)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants