deploy: a7b6433

FigLogger.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>SimLogger.FigLogger module &mdash; SimLogger  documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 

SimLogger.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>SimLogger.SimLogger module &mdash; SimLogger  documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
@@ -47,6 +47,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">SimLogger.SimLogger module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#module-SimLogger.SimLogger">SimLogger.SimLogger Functions</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#SimLogger.SimLogger.convertLog"><code class="docutils literal notranslate"><span class="pre">convertLog()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#SimLogger.SimLogger.getObj"><code class="docutils literal notranslate"><span class="pre">getObj()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#SimLogger.SimLogger.getObjectFromUniqueId"><code class="docutils literal notranslate"><span class="pre">getObjectFromUniqueId()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#SimLogger.SimLogger.isSimTagUsed"><code class="docutils literal notranslate"><span class="pre">isSimTagUsed()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#SimLogger.SimLogger.logNotes"><code class="docutils literal notranslate"><span class="pre">logNotes()</span></code></a></li>
@@ -140,6 +141,31 @@ <h1>SimLogger.SimLogger module<a class="headerlink" href="#simlogger-simlogger-m
 </dl>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="SimLogger.SimLogger.getObj">
+<span class="sig-prename descclassname"><span class="pre">SimLogger.SimLogger.</span></span><span class="sig-name descname"><span class="pre">getObj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">simTag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">objTag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">objFolder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'data/obj'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/SimLogger/SimLogger.html#getObj"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#SimLogger.SimLogger.getObj" title="Permalink to this definition"></a></dt>
+<dd><p>Loads a previously saved object using the simTag and objTag
+If there are multiple objects that have this, we are automatically
+grabbing the first instance found (by alphabetical file name).
+If you accidently saved multiple copies (differentiated by the
+date-time string, you should use <cite>getObjectFromUniqueId()</cite></p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>simTag</strong> (<em>str</em>) – Unique tag for the simulation</p></li>
+<li><p><strong>objTag</strong> (<em>str</em>) – Unique tag for the object saved</p></li>
+<li><p><strong>objFolder</strong> (<em>str</em>) – Folder containing the pickled file</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Loaded pickled object</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>obj (Object)</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="SimLogger.SimLogger.getObjectFromUniqueId">
 <span class="sig-prename descclassname"><span class="pre">SimLogger.SimLogger.</span></span><span class="sig-name descname"><span class="pre">getObjectFromUniqueId</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uniqueId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">objFolder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'data/obj'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/SimLogger/SimLogger.html#getObjectFromUniqueId"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#SimLogger.SimLogger.getObjectFromUniqueId" title="Permalink to this definition"></a></dt>

SimNotify.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>SimLogger.SimNotify module &mdash; SimLogger  documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
@@ -94,7 +94,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 To do this, go to <a class="reference external" href="https://notify.run/">https://notify.run/</a> and create a new channel. Copy the link that it
 generates. This link will be the URL to go to and see any notifications.</p>
 <p>Using that link you can then send notifications:</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">SimLogger</span> <span class="kn">import</span> <span class="n">SimNotify</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">SimLogger</span><span class="w"> </span><span class="kn">import</span> <span class="n">SimNotify</span>
 <span class="n">endpoint</span> <span class="o">=</span> <span class="s2">&quot;paste-link-here&quot;</span>
 <span class="n">SimNotify</span><span class="o">.</span><span class="n">sendNotification</span><span class="p">(</span><span class="s2">&quot;Hello World&quot;</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">)</span>
 </pre></div>

_modules/SimLogger/FigLogger.html

@@ -6,7 +6,7 @@
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>SimLogger.FigLogger &mdash; SimLogger  documentation</title>
-      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
@@ -71,14 +71,14 @@
            <div itemprop="articleBody">
 
   <h1>Source code for SimLogger.FigLogger</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">SimLogger</span> <span class="kn">import</span> <span class="n">SimLogger</span>
-<span class="kn">import</span> <span class="nn">figurl</span> <span class="k">as</span> <span class="nn">fig</span>
-<span class="kn">import</span> <span class="nn">plotly.express</span> <span class="k">as</span> <span class="nn">px</span>
-<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
-<span class="kn">import</span> <span class="nn">os</span>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">SimLogger</span><span class="w"> </span><span class="kn">import</span> <span class="n">SimLogger</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">figurl</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">fig</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">plotly.express</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">px</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">pandas</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pd</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
 
 
-<div class="viewcode-block" id="createPlot"><a class="viewcode-back" href="../../FigLogger.html#SimLogger.FigLogger.createPlot">[docs]</a><span class="k">def</span> <span class="nf">createPlot</span><span class="p">(</span>
+<div class="viewcode-block" id="createPlot"><a class="viewcode-back" href="../../FigLogger.html#SimLogger.FigLogger.createPlot">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">createPlot</span><span class="p">(</span>
     <span class="n">simTag</span><span class="p">,</span>
     <span class="n">objTag</span><span class="p">,</span>
     <span class="n">x</span><span class="p">,</span>
@@ -137,7 +137,7 @@ <h1>Source code for SimLogger.FigLogger</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">url</span></div>
 
 
-<div class="viewcode-block" id="savePlotly"><a class="viewcode-back" href="../../FigLogger.html#SimLogger.FigLogger.savePlotly">[docs]</a><span class="k">def</span> <span class="nf">savePlotly</span><span class="p">(</span>
+<div class="viewcode-block" id="savePlotly"><a class="viewcode-back" href="../../FigLogger.html#SimLogger.FigLogger.savePlotly">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">savePlotly</span><span class="p">(</span>
     <span class="n">simTag</span><span class="p">,</span> <span class="n">objTag</span><span class="p">,</span> <span class="n">ff</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">objFolder</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">&quot;data&quot;</span><span class="p">,</span> <span class="s2">&quot;obj&quot;</span><span class="p">),</span> <span class="n">makeNote</span><span class="o">=</span><span class="kc">True</span>
 <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Save a previously created plotly graph to the cloud for remote access</span>