search

dtamayo / reboundx

A library for adding additional forces to the REBOUND N-body integration package
GNU General Public License v3.0
80 stars 60 forks source link

Add hyperlinked implementation paper #116

Closed sabaronett closed 8 months ago

dtamayo commented 9 months ago

Thanks Stanley!

It looks like whole blocks of documentation were moved around, so the diff is quite large and it's hard to tell what changed. What are the changes?

dtamayo commented 8 months ago

Hi Stanley,

Sorry for the slow reply. That's odd. I just tried adding your one-liner myself and rerunning the documentation, and I just get the one-line change in effects.rst. It may be that something in how the documentation is built is platform dependent. In any case, I just made the change myself (and thanked you in the commit!). Really appreciate your help.

And so sorry for the awful shooting at UNLV...what a senseless and devastating tragedy..

sabaronett commented 8 months ago

Hi Dan,

No worries. Thank you for your condolences. Luckily, I was (and still am) in NYC for my CCA pre-doc at the time but received alerts in real-time as it was unfolding and throughout the rest of the day.

The difference in rebuilding the documentation is interesting, and I also wonder if it's platform dependent. However, I don't see the update having taken effect on the Implemented Effects page (screenshot below), even though your commit was about 40 hours ago. Does readthedocs take more than 24 hours to rebuild?

image

dtamayo commented 8 months ago

Hey @sabaronett,

Yeah it looks like it just takes a while to update. Seems to be working now!

sabaronett commented 8 months ago

Hi @dtamayo,

Sorry to keep bothering you, but are you sure? I'm still seeing this here across multiple browsers and when InPrivate or Incognito:

image

Thanks in advance.

dtamayo commented 8 months ago

That's weird...maybe it's a caching issue? If I click on your link I see the same thing, but if I scroll up to the side bar and click implemented effects and then click on tides_constant_time_lag I see it updated

sabaronett commented 8 months ago

Ah, you're looking at the wrong effect. This pull request is for (1.11.1.) Parameter Interpolation, not (1.6.2.) tides_constant_time_lag (TCTL). The latter has had the correct implementation paper link for a while, but I noticed our paper was missing for the former. Hope that helps clarify things.

dtamayo commented 8 months ago

Agh, thanks for your persistence! It turns out the readthedocs config file format I was using was deprecated, and the readthedocs builds were failing. I've fixed this now and it seems to work. Thanks so much for the catch!

sabaronett commented 8 months ago

Ah, that might explain all the seemingly random changes to effects.rst in my original commit when I attempted to rebuild on my machine. Great job figuring that out, and no problem! Thanks again for helping link our paper.