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

Documentation overhaul #532

Merged
merged 44 commits into from
May 25, 2016
Merged

Documentation overhaul #532

merged 44 commits into from
May 25, 2016

Conversation

unoebauer
Copy link
Contributor

@unoebauer unoebauer commented Mar 30, 2016 •
edited
Loading

With this PR, we intend to overhaul the documentation, making it more accessible to new users and covering previously uncommented aspects of Tardis. This branch will be regularly pushed to docs-prepare, thus making the new documentation available at:

http://tardis.readthedocs.io/en/docs-prepare_release/index.html

Current Status

(Partially) Modified, Updated and Clean-up:

  • Installation
  • Quickstart Guide
  • Ejecta Model Setup
  • Examples (only one example so far)
  • Configuration (However, @ftsamis is currently overhauling the config system)
  • Credits (not fully up-to-date)
  • Reporting Issues
  • References
  • Monte Carlo section (work in progress)

Linked-in as is:

  • Physics section
  • Developer's guide and workflows

Specific Todos:

  • sort out contributors and collaborators, list GSoC and SoCiS students - @wkerzendorf has to decide this
  • rewrite and restructure Monte Carlo part
    • add description of virtual packet scheme
    • add description of basic Monte Carlo principles, packet propagation, estimators, etc...
  • link to/incorporate @aoifeboyle's new plasma documentation
  • expand examples section
  • fix citation keys (new bib file uses firstauthor + publication year, e.g. Lucy1999, or Kerzendorf2014)
  • fix equations and ensure correct rendering

kdexd
kdexd reviewed Mar 30, 2016
View reviewed changes
docs/index.rst



TARDIS is a open-source Monte Carlo radiative-transfer spectral synthesis code
Copy link

Choose a reason for hiding this comment

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

On inserting "open-source" in between, "a" -> "an" conversion was missed out. Just a small typo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out. However, this PR is at a very early, immature state. No need to worry too much about these details now.

@unoebauer
Copy link
Contributor Author

Hi guys - I've made quite a bit of progress with the documentation overhaul. Now would be a good time to get some feedback, @wkerzendorf, @chvogl, @yeganer, @ssim.

You can build the docu locally using the make file in the docu directory:

make html

The root documentation file is then located at _build/html/index.html

unoebauer added 17 commits May 11, 2016 17:37
@unoebauer
Start documentation overhaul
683091e 
* as the initial commit the tardis logo was added
@unoebauer
Layout the new structure of the index page
b3ab8cb
@unoebauer
Add banner, activate some links
79086bb 
* add Tardis banner to index page
* add link to installation and running tardis page
* add a brief summary to top of installation page
@unoebauer
Change html theme, change icon
c8f06a7 
* use sphinx_rtd_theme instead of boostrap theme
@unoebauer
Update and link credits page
c0308f8
@unoebauer
Add examples
03b3502 
* examples are linked on the index page
* separate description of density and composition setup
* detailed description of the three possible density profile setups
@unoebauer
Link abundance setup pages, change structuring
7582879 
* setting up the model is now separated from the examples models part
* added Configuration item to main page (not yet linked to anything)
* detailed description pages on composition setup added
@unoebauer
Perform cleanup
6a3d262
@unoebauer
Add configuration part to new docu structure
ccec57a 
* restructured configuration index
* linked configuration_old (still needs to be updated)
* added explanation to configuration (showing the default config values)
@unoebauer
Add note about config system overhaul
3358704
@unoebauer
Update team list
c728142
@unoebauer
Add Tardis_example description
a9dc13d
@unoebauer
Link Physics and Monte Carlo sections
1fae678
@unoebauer
Add news and references
bd7c294
@unoebauer
Update references
2d30d79
@unoebauer
Link Developing pages
2eb25d6
@unoebauer
Updated development_workflow
ee91db2
@unoebauer
Copy link
Contributor Author

unoebauer commented May 17, 2016 •
edited
Loading

@tardis-sn/tardis-core The current status of the documentation overhaul is available at http://tardis.readthedocs.io/en/docs-prepare_release/index.html.

Please provide feedback

Edit: Please also note the list of changes in the top comment

@kdexd
Copy link

kdexd commented May 17, 2016

@unoebauer This new documentation renders so beautifully ! I will go through the diffs of this PR as well, they would help me understand TARDIS better, as well as you will have this proof read by one 😄

Karan Desai and others added 20 commits May 17, 2016 18:06
Rephrase a sentence in docs/issues.rst
20dcdbb
@unoebauer
Add structure for new Monte Carlo Primer section
bbb3647
@unoebauer
Add draft of MC principles
a61daa1
@unoebauer
Add draft of basic Monte Carlo discretization
fa875f5
@unoebauer
Add outline of propagation page
e9f730b
@unoebauer
Add first draft of Propagation section
a090471 
* still incomplete
@unoebauer
Add basic description of random sampling process
94290d8
@unoebauer
Correct typos
58c7b65
@unoebauer
Finish propagation description
167b273
@unoebauer
Add flow chart
6c46b47
@unoebauer
Activate (empty) line interaction page
febcd48
@unoebauer
Add some bullet points to unfinished pages
8d72327
@unoebauer
Add description of volume-based estimators
d854746
@unoebauer
Add line interaction mode description
2910e85
@unoebauer
Correct some typos and errors in estimators.rst
e485a8c
@unoebauer
Fix typo
b27bfb2
@unoebauer
Add new outline to physics section
a289420
@unoebauer
Start description of virtual packet scheme
00935e9
@unoebauer
Finish draft of virtual packet section
fc1257b
@unoebauer
Fix typos and equation errors
1eb38a0
@unoebauer
Copy link
Contributor Author

@tardis-sn/tardis-core I've completed a complete overhaul of the Monte Carlo primer. Feedback and comments welcome!

@wkerzendorf
Copy link
Member

@unoebauer is it pushed to rtd?

@unoebauer
Copy link
Contributor Author

@wkerzendorf - yes it is - link can be found in the PR summary

@unoebauer
Copy link
Contributor Author

slowly getting to a point at which I think we could merge. I haven't addressed all the milestones initially identified, but we could sort those out later. As I see it the following points should the first things to be changed in a future PR:

  • overhaul the physics sections along the outline currently given
  • combine all the workflow, how to contribute and development guidelines into a concise section
  • fill in more instructive examples
  • overhaul the configuration system description (this should be done after @ftsamis completed his project)

@tardis-sn/tardis-core: please have a look again at the current stage of documentation and let me know if there are typos/errors in equations or anything critical that I have missed or got wrong.

After this reviewing process - I'd say we should slowly merge...

@wkerzendorf wkerzendorf merged commit fbd9d9d into tardis-sn:master May 25, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@unoebauer @kdexd @wkerzendorf @chvogl