Allow some passing of kwargs to activities

mattdailis · Jul 6, 2024 · e8314e7 · e8314e7
1 parent 3ecb405
commit e8314e7
Show file tree

Hide file tree

Showing 52 changed files with 579 additions and 40 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/docs-src/2_guides/telecom.md b/docs-src/2_guides/telecom.md
@@ -8,4 +8,14 @@ distance between them and any obstructions or media in the communication path.
 
 The availability of a communication link depends on whether there is an occultation of some body between the transmitter
 and receiver, whether the transmitter or receiver is able to be pointed towards the other, and whether the transmitter
-or receiver has been allocated for a different purpose and is busy.
+or receiver has been allocated for a different purpose and is busy.
+
+```{math}
+   (a + b)^2 = a^2 + 2ab + b^2
+
+   (a - b)^2 = a^2 - 2ab + b^2
+```
+
+https://www.mathworks.com/discovery/link-budget.html
+
+http://www.sss-mag.com/pdf/an9804.pdf
diff --git a/docs-src/common-errors.md b/docs-src/common-errors.md
@@ -0,0 +1,17 @@
+# Common Errors
+
+This section describes some errors you might encounter, and what to do about them
+
+## ImportError - circular import
+
+```
+ImportError: cannot import name '...' from partially initialized module 'mission' (most likely due to a circular import)
+```
+
+This error means you have two python files that import each other. This can occur if you have an activity defined in
+one file, and a model in another, and the two reference each other.
+
+The recommended practice here is _not_ to import activities from the model file - activities should reference the model,
+not the other way around. The activity files will need to be imported from your main file prior to running simulation.
+Convenient as it may seem, we do _not_ recommend using your model file as your main file - make a separate `main.py` and 
+import both the model and the activities.
diff --git a/docs-src/index.md b/docs-src/index.md
@@ -31,6 +31,7 @@ quickstart
 2_guides/index
 3_explanation/index
 apidocs/index
+common-errors
 ```
 
 ```{toctree}

diff --git a/docs/1_tutorials/1_gettingstarted.html b/docs/1_tutorials/1_gettingstarted.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/1_tutorials/index.html b/docs/1_tutorials/index.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/1_tutorials/tutorial2.html b/docs/1_tutorials/tutorial2.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/2_guides/datamodel.html b/docs/2_guides/datamodel.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/2_guides/index.html b/docs/2_guides/index.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>
@@ -352,5 +353,6 @@ <h1>Guides<a class="headerlink" href="#guides" title="Link to this heading">¶</
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=4e2eecee"></script>
+    <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     </body>
 </html>
diff --git a/docs/2_guides/jupyter.html b/docs/2_guides/jupyter.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/2_guides/powermodel.html b/docs/2_guides/powermodel.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/2_guides/scheduling.html b/docs/2_guides/scheduling.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/2_guides/spice.html b/docs/2_guides/spice.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/2_guides/telecom.html b/docs/2_guides/telecom.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>
@@ -302,6 +303,12 @@ <h1>Modeling Telecom<a class="headerlink" href="#modeling-telecom" title="Link t
 <p>The availability of a communication link depends on whether there is an occultation of some body between the transmitter
 and receiver, whether the transmitter or receiver is able to be pointed towards the other, and whether the transmitter
 or receiver has been allocated for a different purpose and is busy.</p>
+<div class="math-wrapper docutils container">
+<div class="math notranslate nohighlight">
+\[ \begin{align}\begin{aligned}   (a + b)^2 = a^2 + 2ab + b^2\\   (a - b)^2 = a^2 - 2ab + b^2\end{aligned}\end{align} \]</div>
+</div>
+<p>https://www.mathworks.com/discovery/link-budget.html</p>
+<p>http://www.sss-mag.com/pdf/an9804.pdf</p>
 </section>
 
         </article>
@@ -357,5 +364,6 @@ <h1>Modeling Telecom<a class="headerlink" href="#modeling-telecom" title="Link t
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=4e2eecee"></script>
+    <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     </body>
 </html>
diff --git a/docs/3_explanation/co-simulation.html b/docs/3_explanation/co-simulation.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/3_explanation/command-errors.html b/docs/3_explanation/command-errors.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/3_explanation/fidelity.html b/docs/3_explanation/fidelity.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/3_explanation/index.html b/docs/3_explanation/index.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/3_explanation/planning.html b/docs/3_explanation/planning.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/3_explanation/simulation.html b/docs/3_explanation/simulation.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/_sources/2_guides/telecom.md.txt b/docs/_sources/2_guides/telecom.md.txt
@@ -8,4 +8,14 @@ distance between them and any obstructions or media in the communication path.
 
 The availability of a communication link depends on whether there is an occultation of some body between the transmitter
 and receiver, whether the transmitter or receiver is able to be pointed towards the other, and whether the transmitter
-or receiver has been allocated for a different purpose and is busy.
+or receiver has been allocated for a different purpose and is busy.
+
+```{math}
+   (a + b)^2 = a^2 + 2ab + b^2
+
+   (a - b)^2 = a^2 - 2ab + b^2
+```
+
+https://www.mathworks.com/discovery/link-budget.html
+
+http://www.sss-mag.com/pdf/an9804.pdf
diff --git a/docs/_sources/common-errors.md.txt b/docs/_sources/common-errors.md.txt
@@ -0,0 +1,17 @@
+# Common Errors
+
+This section describes some errors you might encounter, and what to do about them
+
+## ImportError - circular import
+
+```
+ImportError: cannot import name '...' from partially initialized module 'mission' (most likely due to a circular import)
+```
+
+This error means you have two python files that import each other. This can occur if you have an activity defined in
+one file, and a model in another, and the two reference each other.
+
+The recommended practice here is _not_ to import activities from the model file - activities should reference the model,
+not the other way around. The activity files will need to be imported from your main file prior to running simulation.
+Convenient as it may seem, we do _not_ recommend using your model file as your main file - make a separate `main.py` and 
+import both the model and the activities.
diff --git a/docs/_sources/index.md.txt b/docs/_sources/index.md.txt
@@ -31,6 +31,7 @@ quickstart
 2_guides/index
 3_explanation/index
 apidocs/index
+common-errors
 ```
 
 ```{toctree}

diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/apidocs/pymerlin/pymerlin.duration.html b/docs/apidocs/pymerlin/pymerlin.duration.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/apidocs/pymerlin/pymerlin.html b/docs/apidocs/pymerlin/pymerlin.html
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>

diff --git a/docs/apidocs/pymerlin/pymerlin.model_actions.html b/docs/apidocs/pymerlin/pymerlin.model_actions.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="Architecture" href="../../architecture.html" /><link rel="prev" title="pymerlin.duration" href="pymerlin.duration.html" />
+<link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="Common Errors" href="../../common-errors.html" /><link rel="prev" title="pymerlin.duration" href="pymerlin.duration.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
         <title>pymerlin.model_actions - pymerlin 0.0.5 documentation</title>
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../../common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>
@@ -363,12 +364,12 @@ <h3>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h3
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="../../architecture.html">
+          <a class="next-page" href="../../common-errors.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Architecture</div>
+                <div class="title">Common Errors</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>

diff --git a/docs/architecture.html b/docs/architecture.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Developing pymerlin" href="developer.html" /><link rel="prev" title="pymerlin.model_actions" href="apidocs/pymerlin/pymerlin.model_actions.html" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Developing pymerlin" href="developer.html" /><link rel="prev" title="Common Errors" href="common-errors.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
         <title>Architecture - pymerlin 0.0.5 documentation</title>
@@ -243,6 +243,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="common-errors.html">Common Errors</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul class="current">
@@ -324,14 +325,14 @@ <h2>Approachability over performance<a class="headerlink" href="#approachability
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="apidocs/pymerlin/pymerlin.model_actions.html">
+          <a class="prev-page" href="common-errors.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pymerlin.model_actions</span></code></div>
+                <div class="title">Common Errors</div>
 
               </div>
             </a>
-Original file line number
+Diff line change
@@ Expand Up / @@ -243,6 +243,7 @@ @@
     </li>
     </ul>
     </li>
+    <li class="toctree-l1"><a class="reference internal" href="../common-errors.html">Common Errors</a></li>
     </ul>
     <p class="caption" role="heading"><span class="caption-text">Development</span></p>
     <ul>
@@ Expand Down @@