mkdocs

[hannorein]

The documentation is still a bit sparse. I don't think we need to add much more. The examples show most of the functionality. However, would you have any objections to me converting the documentation from sphinx to mkdocs? Mkdocs has the nice feature which lets you put C and python code next to each other, so we don't need two different pages explaining the same feature in two different languages?

[matthewholman]

I don't have any objections. @aryaakmal has been working on the documentation. He may have comments.

[aryaakmal]

I am not familiar with mkdocs ... but I didn't know about sphinx until recently either. I would need to get up to speed, but if its a superior system, by all means - please feel free to modify as you see fit, or point me in the right direction if you prefer.

On Tue, Feb 14, 2023 at 11:05 AM matthewholman @.***> wrote:

I don't have any objections. @aryaakmal https://github.com/aryaakmal has been working on the documentation. He may have comments.

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1429990503, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ6R3J733MO42JFXQETWXOUL5ANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

[hannorein]

I'm not sure I would call it superior. I'll give it a go and you can decide...

[aryaakmal]

I'm sure that if you would rather use it, then we should do so.

On Tue, Feb 14, 2023 at 11:59 AM Hanno Rein @.***> wrote:

I'm not sure I would call it superior. I'll give it a go and you can decide...

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1430075115, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ2YQO7ZDSN45PVRM5TWXO2WXANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

[aryaakmal]

looks really nice.

[aryaakmal]

Forgive me for being picky - this is not significant, and perhaps it is the standard way to refer to a central inverse square force in this context. But as a non-astronomer, the description of the direct gravitational force in available force routines in the documentation as 'Gravitational force (1/r) from the sun' strikes me as a bit odd. I may be way off-base on this, as the context makes clear that it is the potential we are talking about here and the word 'force' has a different connotation here.

[aryaakmal]

It may also be worth mentioning in the intro to https://assist.readthedocs.io/en/latest/forces/ that EIH represents the effect of leading corrections of order (v/c)^2 to the Minkowski metric.

[hannorein]

Good point. Do you want to change that? All you need to do is edit the file docs/forces.md.

(Please keep on being picky!)

[aryaakmal]

Will do, Hanno.

On Wed, Feb 15, 2023 at 4:33 PM Hanno Rein @.***> wrote:

Good point. Do you want to change that? All you need to do is edit the file docs/forces.md.

(Please keep on being picky!)

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1432065253, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ7HVXIS3QNB2NF4PUDWXVDR7ANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

[hannorein]

Great. Thanks! One other thing I was also wondering about is what the precise definition of the A coefficient is. I couldn't quite figure it out by looking at the Marsden paper.

[aryaakmal]

This is probably obvious, perhaps @matthewholman can elucidate further. My understanding is that they are simply phenomenological parameters with units of acceleration that represent the effects of radiation pressure, yarkovsky effect or outgassing. As far as I know their values are not based on any ab initio considerations ... but you already knew that.

On Wed, Feb 15, 2023 at 4:55 PM Hanno Rein @.***> wrote:

Great. Thanks! One other thing I was also wondering about is what the precise definition of the A coefficient is. I couldn't quite figure it out by looking at the Marsden paper.

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1432093080, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ2S6VK4YWVVL4HK5VDWXVGGNANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

[matthewholman]

I will add a description of the A coefficients.

[aryaakmal]

@matthewholman - to the paper?

On Wed, Feb 15, 2023 at 5:03 PM matthewholman @.***> wrote:

I will add a description of the A coefficients.

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1432102290, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ32EJCKVUOOMBSTQSDWXVHB5ANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

[matthewholman]

To the docs first. I'll add a clarification to the paper when we get the referee reports.

On Wed, Feb 15, 2023 at 5:04 PM Arya Akmal @.***> wrote:

@matthewholman - to the paper?

On Wed, Feb 15, 2023 at 5:03 PM matthewholman @.***> wrote:

I will add a description of the A coefficients.

— Reply to this email directly, view it on GitHub < https://github.com/matthewholman/assist/issues/68#issuecomment-1432102290 , or unsubscribe < https://github.com/notifications/unsubscribe-auth/AOMJBQ32EJCKVUOOMBSTQSDWXVHB5ANCNFSM6AAAAAAU3X2BKY

. You are receiving this because you were mentioned.Message ID: @.***>

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1432103930, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA5CVWJ7UDSOFG6AGFAELHLWXVHG7ANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

-- Matthew J. Holman, PhD Senior Astrophysicist Center for Astrophysics | Harvard & Smithsonian 60 Garden Street, MS #51 Cambridge, MA 02138 (617) 496-7775

[hannorein]

Just in case it helps and is not obvious: you can include latex equations in the docs, e.g. \( A_1= \ldots \).

[aryaakmal]

I just fixed it ... thank you, @Hannorein.

I did not notice the ^2 was not rendered until after I pushed it.

On Wed, Feb 15, 2023 at 5:12 PM Hanno Rein @.***> wrote:

Just in case it helps and is not obvious: you can include latex equations in the docs, e.g. ( A_1= \ldots ).

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1432114393, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ5L6JG6ZIEG2T5ILM3WXVIFLANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>

[hannorein]

Great. Another tip in case it helps: You can easily run mkdocs locally.

pip install mkdocs mkdocs-material mkdocs-jupyter  mkdocs-simple-hooks mkdocs-video
mkdocs serve --no-livereload

[aryaakmal]

Thank you. I will use that next time before pushing.

On Wed, Feb 15, 2023 at 5:17 PM Hanno Rein @.***> wrote:

Great. Another tip in case it helps: You can easily run mkdocs locally.

pip install mkdocs mkdocs-material mkdocs-jupyter mkdocs-simple-hooks mkdocs-video mkdocs serve --no-livereload

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/issues/68#issuecomment-1432120240, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ5PYAIKJHLLGEKU3C3WXVIWRANCNFSM6AAAAAAU3X2BKY . You are receiving this because you were mentioned.Message ID: @.***>