Skip to content

Fix small issues, mostly docs (fixes #434)#435

Merged
HKaras merged 3 commits intomainfrom
fixes/docs
Aug 7, 2023
Merged

Fix small issues, mostly docs (fixes #434)#435
HKaras merged 3 commits intomainfrom
fixes/docs

Conversation

@stestoll
Copy link
Collaborator

@stestoll stestoll commented Aug 4, 2023

No description provided.

@stestoll stestoll marked this pull request as draft August 4, 2023 20:02
@stestoll stestoll self-assigned this Aug 4, 2023
@stestoll stestoll added the docs Improvements or additions to documentation label Aug 4, 2023
@stestoll stestoll requested a review from HKaras August 4, 2023 20:02
@stestoll stestoll marked this pull request as ready for review August 4, 2023 23:17
Choosing a time range
*************************

The time range depends on the expected range of distances, but is typically in the range of 0.5 to several microseconds. To construct a time vector, use the ``linspace`` function from NumPy: ::
Copy link
Member

Choose a reason for hiding this comment

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

I am unsure of this wording here. When creating the model you have already got your data, so you aren't so much choosing your time range more inputting it. I also wouldn't say that the time range is dependent on the distances, more the range of extractable distances is dependent upon the time axis.

Additionally most people use a tau1 of 0.4us for 4pDEER, so the range starts before 0.5 us.

HKaras
HKaras previously approved these changes Aug 6, 2023
Copy link
Member

@HKaras HKaras left a comment

Choose a reason for hiding this comment

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

It all looks good except I don't fully agree with the language around 'Choosing a time range'.

@stestoll
Copy link
Collaborator Author

stestoll commented Aug 7, 2023

I modified the language. Good now?

Copy link
Member

@HKaras HKaras left a comment

Choose a reason for hiding this comment

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

Looks good thanks.

@HKaras HKaras merged commit 40130b7 into main Aug 7, 2023
@HKaras HKaras deleted the fixes/docs branch August 7, 2023 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants