Merge pull request #8 from kesslerlib/docs_fix

docs fix

Author: Sceki

.github/workflows/build.yml

@@ -29,7 +29,10 @@ jobs:
         pip install matplotlib
         pip install jupyter
         pip install numpy
-        pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0+cpu -f https://download.pytorch.org/whl/cpu/torch_stable.html
+        pip install dsgp4
+        pip install pyprob
+        pip install skyfield
+        pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
         pip install .[dev]
         pip install sphinx
         pip install sphinx-book-theme
@@ -49,4 +52,4 @@ jobs:
       if: ${{ github.event_name == 'push' }}
       uses: JamesIves/github-pages-deploy-action@v4
       with:
-        folder: docs/_build/html # The folder the action should deploy.
+        folder: docs/_build/html # The folder the action should deploy.

README.md

@@ -1,4 +1,4 @@
-## ⚠️ We are in the process of updating Kessler. Because of this, Kessler is now in maintenance mode and not all functionalities might be working for a few days ⚠️
+# Kessler
 
 <!-- PROJECT LOGO -->
 <br />
@@ -90,8 +90,6 @@ If you would like to learn more about or cite the techniques Kessler uses, pleas
 
 ## Installation
 
-### How to install
-
 To install kessler, do the following:
 
 ```

docs/conf.py

@@ -27,12 +27,24 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["myst_nb",
-              "sphinx.ext.intersphinx",
-              "sphinx.ext.autodoc",
-              "sphinx.ext.autosummary",
-              "sphinx.ext.doctest",
-              ]
+extensions = ["myst_nb", "sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.autosummary","sphinx.ext.napoleon"]
+
+
+# build the templated autosummary files
+autosummary_generate = True
+autosummary_imported_members = True
+napoleon_google_docstring = True
+numpydoc_show_class_members = False
+panels_add_bootstrap_css = False
+
+autosectionlabel_prefix_document = True
+
+# katex options
+#
+#
+katex_prerender = True
+
+napoleon_use_ivar = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -43,13 +55,12 @@
     "matplotlib": ("https://matplotlib.org/stable/", None),
 }
 
-
 autoclass_content = 'both'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", ".DS_Store"]
+exclude_patterns = ["_build", ".DS_Store", ".pickle",".txt",'jupyter_execute/**/*.ipynb','jupyter_execute/*.ipynb']
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -69,7 +80,7 @@
 html_theme_options = {
     "repository_url": "https://github.com/kesslerlib/kessler/",
     "repository_branch": "master",
-    "path_to_docs": "docs",
+    "path_to_docs": "doc",
     "use_repository_button": True,
     "use_issues_button": True,
     "launch_buttons": {
@@ -81,13 +92,12 @@
 
 nb_execution_mode = "force"
 
-nb_execution_excludepatterns = ['basics.ipynb','cdms_analysis_and_plotting.ipynb','LSTM_training.ipynb']
-
-# Force printing traceback to stderr on execution error.
-nb_execution_show_tb = True
-
-# Set a longer timeout for notebook execution.
-nb_execution_timeout = 120
+nb_execution_excludepatterns = [
+    "LSTM_training.ipynb",
+    "basics.ipynb",
+    "probabilistic_programming_module.ipynb",
+    "plotting.ipynb"
+]
 
 latex_engine = "xelatex"
 
@@ -97,4 +107,4 @@
     "deflist",
     "dollarmath",
     "html_image",
-]
+]

docs/index.md

@@ -9,7 +9,7 @@ Kessler also includes a novel generative model of conjunction events and CDM seq
 
 For more details on the model and results, check out our publications listed in the README of the repository. 
 
-The authors are [Giacomo Acciarini](https://www.esa.int/gsp/ACT/team/giacomo_acciarini/), [Atılım Güneş Baydin](https://gbaydin.github.io/), [Dario Izzo](https://www.esa.int/gsp/ACT/team/dario_izzo/). The main developer is Giacomo Acciarini (giacomo.acciarini@gmail.com).
+The authors are [Giacomo Acciarini](https://www.esa.int/gsp/ACT/team/giacomo_acciarini/), [Atılım Güneş Baydin](https://gbaydin.github.io/), Francesco Pinto, and the FDL Europe Constellation team.
 
 
 ```{toctree}

docs/notebooks/plotting.ipynb

@@ -34,8 +34,7 @@
    "source": [
     "import kessler\n",
     "import dsgp4\n",
-    "import pyprob\n",
-    "import numpy as np"
+    "import pickle"
    ]
   },
   {
@@ -207,7 +206,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import pickle\n",
     "with open('trace.pickle', 'rb') as f:\n",
     "    trace = pickle.load(f)"
    ]

docs/tutorials.rst

@@ -12,6 +12,8 @@ These tutorials include some basic examples on how to use kessler
 
   notebooks/basics.ipynb
   notebooks/cdms_analysis_and_plotting.ipynb
+  notebooks/plotting.ipynb
+
 
 Advanced
 ^^^^^^^^^^^

setup.py

@@ -30,8 +30,8 @@ def read_package_variable(key):
     author='ESA FDL Europe Constellations Team',
     # author_email='',
     packages=find_packages(),
-    install_requires=['numpy', 'matplotlib', 'torch>=1.5.1', 'dsgp4', 'skyfield>=1.26', 'pyprob', 'pandas'],
-    extras_require={'dev': ['pytest', 'coverage', 'pytest-xdist', 'docker', 'sgp4>=2.20']},
+    install_requires=['pyprob', 'numpy', 'matplotlib', 'torch>=1.5.1', 'dsgp4', 'skyfield>=1.26', 'pandas'],
+    extras_require={'dev': ['pytest', 'coverage', 'pytest-xdist']},
     # url='https://github.com/kessler/kessler',
     classifiers=['License :: OSI Approved :: BSD License', 'Programming Language :: Python :: 3'],
     license='BSD'