Skip to content
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

Jump to bottom

Update Documentation #773

Merged
merged 6 commits into from Jul 31, 2017
Merged

Update Documentation #773

merged 6 commits into from Jul 31, 2017

Conversation

unoebauer
Copy link
Contributor

This PR performs a number of small updates in the Documentation. In particular:

  • update of list of works using TARDIS
  • update news page: GSOC17
  • remove warning about broken GUI since it has been fixed
  • update description of spectrum configuration part and add links to description of virtual packet mode and formal integral

yeganer
yeganer suggested changes Jul 28, 2017
View reviewed changes
Copy link
Contributor

@yeganer yeganer left a comment

Choose a reason for hiding this comment

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

I found one small issue with the configuration documentation.

docs/configuration/configuration_old.rst

Start and end are given as Quantities with units. If they are given in
frequency space they are switched around if necessary. The number of bins is
just an integer. Finally, the method option selects the final spectral synthesis mode. Currently, there are three options:
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add that this is only relevant for the tardis script when saving the output as ascii.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, currently this may be true. But eventually, some of these will be mutually exclusive. For example, when the Formal integral method is selected, the virtual packet scheme will be deactivated.

@wkerzendorf wkerzendorf merged commit 3f33842 into tardis-sn:master Jul 31, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yeganer yeganer yeganer requested changes

@wkerzendorf wkerzendorf wkerzendorf approved these changes

@chvogl chvogl chvogl approved these changes

Assignees
No one assigned
Labels
documentation priority - low 🐌
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@unoebauer @wkerzendorf @yeganer @chvogl