Merge branch 'master' of https://github.com/esa/dSGP3

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       # Start ssh-agent but set it to use the same ssh_auth_sock value.
       # The agent will be running in all steps after this, so it
       # should be one of the first.
@@ -60,7 +60,7 @@ jobs:
           coverage run -m pytest
           coverage xml
       - name: Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true

README.md

@@ -12,7 +12,7 @@ Differentiable SGP4.
   <p align="center">
     Differentiable SGP4
     <br />
-    <a href="https://esa.github.io/dSGP4/"><strong>Explore the docs »</strong></a>
+    <a href="https://esa.github.io/dSGP4"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://github.com/esa/dSGP4/issues/new/choose">Report bug</a>
@@ -33,7 +33,7 @@ Differentiable SGP4.
 * [Atılım Güneş Baydin](http://gbaydin.github.io/)
 * [Dario Izzo](https://www.esa.int/gsp/ACT/team/dario_izzo/)
 
-The project originated after the work of the authors at the University of Oxford.
+The project originated after the work of the authors at the [University of Oxford OX4AI Lab](https://oxai4science.github.io/).
 
 ## Acknowledgements:
 

dsgp4/sgp4_batched.py

@@ -1,20 +1,21 @@
 import torch
 import numpy 
 
-# This should be the default and renamed to sgp4. When we are sure it works, we can remove the old sgp4.
 def sgp4_batched(satrec, tsince):
     """
-    This function represents the SGP4 propagator. Having created the TLE object, and
-    initialized the propagator (using `kessler.sgp4.sgp4init`), one can use this method
-    to propagate the TLE at future times. The method returns the satellite position and velocity
+    This function represents the batch SGP4 propagator. 
+    It resembles `sgp4`, but accepts batches of TLEs.
+    Having created the TLE object, and initialized the propagator (using `kessler.sgp4.sgp4init`), 
+    one can use this method to propagate the TLE at future times. 
+    The method returns the satellite position and velocity
     in km and km/s, respectively, after `tsince` minutes.
 
     Args:
         - satrec (``kessler.tle.TLE``): TLE object
         - tsince (``torch.tensor``): time to propagate, since the TLE epoch, in minutes
 
     Returns:
-        - state (``torch.tensor``): a 2x3 tensor, where the first row represents the spacecraft
+        - batch_state (``torch.tensor``): a batch of 2x3 tensors, where the first row represents the spacecraft
                                     position (in km) and the second the spacecraft velocity (in km/s)
     """