Merge branch 'hotfix/tutorial_module' into 'main'

Hotfix/Tutorial Module

See merge request trajectory/tracktable!252

Documentation/conf.py

@@ -76,6 +76,8 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    'sphinx.ext.graphviz',
+    # 'sphinxcontrib.video',
     'breathe',
     'nbsphinx',
     'nbsphinx_link'

environment.yml

@@ -4,20 +4,12 @@ channels:
   - defaults
 dependencies:
   - python=3.8
-  - cartopy
-  - folium
+  - pip
+  - tracktable
   - ipykernel
-  - matplotlib
-  - numpy
   - pandoc
-  - pip
-  - pykdtree
-  - pyshp
-  - pytz
-  - scipy
-  - sphinx
+  - sphinx<4.1.0 # Issues with C++ and templates with newer versions
   - pip:
     - breathe
     - nbsphinx
-    - nbsphinx-link
-    - tracktable
+    - nbsphinx-link

tracktable/Python/tracktable/CMakeLists.txt

@@ -104,25 +104,25 @@ file(GLOB tutorial_notebooks "examples/tutorials/*.ipynb")
 install(
   FILES ${tutorial_notebooks}
   DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/tutorials
-  )
+)
 
 file(GLOB tutorial_helpers "examples/tutorials/*.py")
-  install(
-    FILES ${tutorial_helpers}
-    DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/tutorials
-    )
+install(
+  FILES ${tutorial_helpers}
+  DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/tutorials
+)
 
 file(GLOB analytic_demo_notebooks "examples/analytic_demos/*.ipynb")
-  install(
-    FILES ${analytic_demo_notebooks}
-    DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/analytic_demos
-    )
+install(
+  FILES ${analytic_demo_notebooks}
+  DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/analytic_demos
+)
 
 file(GLOB analytic_demo_images "examples/analytic_demos/demo_images/*.*")
-  install(
-    FILES ${analytic_demo_images}
-    DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/analytic_demos/demo_images
-    )
+install(
+  FILES ${analytic_demo_images}
+  DESTINATION ${PYTHON_INSTALL_PREFIX}/examples/analytic_demos/demo_images
+)
 
 file(GLOB example_data_files "examples/data/*.*")
 install(

tracktable/Python/tracktable/examples/analytic_demos/__init__.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2017-2020, National Technology & Engineering Solutions of
+#   Sandia, LLC (NTESS).
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+pass

tracktable/Python/tracktable/examples/python_scripts/__init__.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2017-2020, National Technology & Engineering Solutions of
+#   Sandia, LLC (NTESS).
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+pass

tracktable/Python/tracktable/examples/tutorials/__init__.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2017-2020, National Technology & Engineering Solutions of
+#   Sandia, LLC (NTESS).
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+pass