Merge pull request #121 from darioizzo/master

Docs Improved
esa · Apr 11, 2020 · e9b0a01 · e9b0a01
2 parents 8396f00 + 95ff196
commit e9b0a01
Show file tree

Hide file tree

Showing 19 changed files with 23,185 additions and 11,632 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,7 +2,7 @@
 set(PYKEP_PROJECT_VERSION 2.5)
 
 # CMake version check.
-cmake_minimum_required(VERSION 3.2)
+cmake_minimum_required(VERSION 3.3)
 
 # Module path setup.
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake_modules" "${CMAKE_SOURCE_DIR}/cmake_modules/yacma")

diff --git a/doc/sphinx/credits.rst b/doc/sphinx/credits.rst
@@ -10,7 +10,7 @@ compatibility between the two projects.
 
 **pykep** is in use at the European Space Agency's Advanced Concepts Team since 2006.
 
-**Main Developers**:
+**Main Developer**:
 
 Dario Izzo (dario.izzo __AT__ esa.int)
 

diff --git a/doc/sphinx/documentation/index.rst b/doc/sphinx/documentation/index.rst
@@ -1,5 +1,5 @@
 ======================
-Code Documentation
+API reference
 ======================
 
 pykep is made of main modules called :ref:`core`, :ref:`planet`, :ref:`simsflanagan`, :ref:`pontryagin`, :ref:`phasing`, :ref:`trajopt`, :ref:`orbitplots`, :ref:`util`. 

diff --git a/doc/sphinx/downloading.rst b/doc/sphinx/downloading.rst
diff --git a/doc/sphinx/examples/HERA_sc_LPC_EMA_2024c.bsp b/doc/sphinx/examples/HERA_sc_LPC_EMA_2024c.bsp
diff --git a/doc/sphinx/examples/de432s.bsp b/doc/sphinx/examples/de432s.bsp
diff --git a/doc/sphinx/examples/didymos_hor_200101_300101_v01.bsp b/doc/sphinx/examples/didymos_hor_200101_300101_v01.bsp
diff --git a/doc/sphinx/examples/ex1.ipynb b/doc/sphinx/examples/ex1.ipynb
diff --git a/doc/sphinx/examples/ex12.ipynb b/doc/sphinx/examples/ex12.ipynb
diff --git a/doc/sphinx/examples/ex2.ipynb b/doc/sphinx/examples/ex2.ipynb
diff --git a/doc/sphinx/examples/ex3.ipynb b/doc/sphinx/examples/ex3.ipynb
@@ -19,7 +19,19 @@
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "ename": "ModuleNotFoundError",
+     "evalue": "No module named 'pygmo_plugins_nonfree'",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mModuleNotFoundError\u001b[0m                       Traceback (most recent call last)",
+      "\u001b[0;32m<ipython-input-1-d4897bb3ff63>\u001b[0m in \u001b[0;36m<module>\u001b[0;34m\u001b[0m\n\u001b[1;32m      2\u001b[0m \u001b[0;32mimport\u001b[0m \u001b[0mpykep\u001b[0m \u001b[0;32mas\u001b[0m \u001b[0mpk\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m      3\u001b[0m \u001b[0;32mimport\u001b[0m \u001b[0mpygmo\u001b[0m \u001b[0;32mas\u001b[0m \u001b[0mpg\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0;32m----> 4\u001b[0;31m \u001b[0;32mimport\u001b[0m \u001b[0mpygmo_plugins_nonfree\u001b[0m \u001b[0;32mas\u001b[0m \u001b[0mppnf\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m\u001b[1;32m      5\u001b[0m \u001b[0;32mimport\u001b[0m \u001b[0mnumpy\u001b[0m \u001b[0;32mas\u001b[0m \u001b[0mnp\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[1;32m      6\u001b[0m \u001b[0;32mfrom\u001b[0m \u001b[0mpykep\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0mexamples\u001b[0m \u001b[0;32mimport\u001b[0m \u001b[0madd_gradient\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n",
+      "\u001b[0;31mModuleNotFoundError\u001b[0m: No module named 'pygmo_plugins_nonfree'"
+     ]
+    }
+   ],
    "source": [
     "# Imports\n",
     "import pykep as pk\n",
@@ -44,6 +56,8 @@
      "output_type": "stream",
      "text": [
       "Problem name: <class 'pykep.trajopt._mga_lt_nep.mga_lt_nep'>\n",
+      "\tC++ class name: pybind11::object\n",
+      "\n",
       "\tGlobal dimension:\t\t\t92\n",
       "\tInteger dimension:\t\t\t0\n",
       "\tFitness dimension:\t\t\t44\n",
@@ -211,7 +225,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,