Off-Nadir Pointing Attitude Law

bcazabonne · September 17, 2021, 7:23am

I think you will find some interesting information on the following post:

misanthrope:

As an intense Orekit user, I would like to let you know how I appreciate your hard work and how helpful it is to our community. However, I would also like to express a feedback developed over months of usage of your tool: the documentation lacks of a clear physical meaning for a lot of parameters used in some classes/methods. It is really hard to try to make a sense of what one is doing sometimes, ending up in doing trial & error and developing parallel cross-validation tools to see if it is actually executing what the tool suggests; you should really try to focus more on giving an intuitive understanding of what a function/class/method is actually doing, instead of just writing a confusing and (often) misleading description (just to give you an example, under the CelestialBodyPointed - Constructor Detail, what do you mean by “phasingCel, phasingSat”? Phasing of what and with respect to what?). Please take it with no offense, it is just a personal feedback after months of intense usage of Orekit. If needed, I would be more than willing to contribute to build a more clear and meaningful documentation.

I understand your remark and I know that we have to improve the documentation. We try to write an understandable documentation for each class and method of Orekit. Also, we try to make class diagrams and documentation on the Maven site as understandable as possible. But sometimes it is a hard work to go into details and contribution are always welcome