From b7d05d7c828ec97ddc54a6dc5c83cff9308edf33 Mon Sep 17 00:00:00 2001 From: Jorge Martinez Date: Mon, 16 Sep 2024 11:06:44 +0200 Subject: [PATCH 1/2] doc: fix readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1e986df..10a3ae1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ spacecraft given two points in space and the time of flight between them. The problem is essential for trajectory planning, particularly for interplanetary missions. -Lamberthub implements multiple algorithms, each named after its author and +This library implements multiple algorithms, each named after its author and publication year, for solving different variations of Lambert's problem. These algorithms can handle different types of orbits, including multi-revolution paths and direct transfers. @@ -61,7 +61,7 @@ v1, v2 = authorYYYY( where `author` is the name of the author which developed the solver and `YYYY` the year of publication. Any of the solvers hosted by the `ALL_SOLVERS` list. -### Parameters and Returns +### Parameters | Parameters | Type | Description | |---------------|-----------|-------------| @@ -77,7 +77,7 @@ the year of publication. Any of the solvers hosted by the `ALL_SOLVERS` list. | `rtol` | `float` | Relative tolerance for the iterative method. | | `full_output` | `bool` | If `True`, returns additional information such as the number of iterations. | -### Returns Table: +### Returns | Returns | Type | Description | |---------------|------------|-------------| From 4cfdf6890ce8a822bc29a6068a79862d64d2451b Mon Sep 17 00:00:00 2001 From: Jorge Martinez Date: Mon, 16 Sep 2024 11:09:36 +0200 Subject: [PATCH 2/2] doc: ignore vale in algorithms table --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 10a3ae1..0a0b5a7 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ Multiple installation methods are supported: ## Available solvers + + | Algorithm | Reference | |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | `gauss1809` | C. F. Gauss, *Theoria motus corporum coelestium in sectionibus conicis solem ambientium*. 1809. | @@ -43,6 +45,8 @@ Multiple installation methods are supported: | `vallado2013` | D. A. Vallado, *Fundamentals of astrodynamics and applications*. Springer Science & Business Media, 2013, vol. 12. | | `izzo2015` | D. Izzo, “Revisiting lambert’s problem,” *Celestial Mechanics and Dynamical Astronomy*, vol. 121, no. 1, pp. 1–15, 2015. | + + ## Using a solver Any Lambert's problem algorithm implemented in `lamberthub` is a Python function