-
Notifications
You must be signed in to change notification settings - Fork 2
Tutorial- og Layout update #210
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.
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
Tutorial- og Layout update #210
Conversation
…d dictionary and calculator into 'tutorials.rst'
There was a problem hiding this 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']
elindgren
left a comment
There was a problem hiding this 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.
|
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! 🌈 |
|
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. |
|
I removed output from the Jupyter notebooks. I think it's ready for merging, I can do that tomorrow. |
Updated tutorials, restructured index to EasyDiffraction-layout, moved dictionary and calculator into 'tutorials.rst'