deploy: a7600b4

Author: freddieknets

_modules/xboinc/df_wu.html

@@ -250,26 +250,26 @@ <h1>Source code for xboinc.df_wu</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="query_subscribed_users">
 <a class="viewcode-back" href="../../api/xboinc/df_wu/index.html#xboinc.df_wu.query_subscribed_users">[docs]</a>
-<span class="k">def</span><span class="w"> </span><span class="nf">query_subscribed_users</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">query_subscribed_users</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Get a list of all users subscribed to the work unit database.</span>
+<span class="sd">    Get a list of all users subscribed to the work unit database with their status.</span>
 
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
-<span class="sd">    list[str]</span>
-<span class="sd">        List of usernames subscribed to the work unit database.</span>
+<span class="sd">    list[tuple[str, str]]</span>
+<span class="sd">        List of tuples containing (username, status) for users subscribed to the work unit database.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">with</span> <span class="n">_get_read_only_user_db_connection</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
         <span class="n">cursor</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
-        <span class="n">cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;SELECT user FROM users&quot;</span><span class="p">)</span>
-        <span class="n">users</span> <span class="o">=</span> <span class="p">[</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cursor</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()]</span>
+        <span class="n">cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;SELECT user, status FROM users&quot;</span><span class="p">)</span>
+        <span class="n">users</span> <span class="o">=</span> <span class="p">[(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cursor</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()]</span>
     <span class="k">return</span> <span class="n">users</span></div>
 
 
 
 <div class="viewcode-block" id="check_user_subscription">
 <a class="viewcode-back" href="../../api/xboinc/index.html#xboinc.df_wu.check_user_subscription">[docs]</a>
-<span class="k">def</span><span class="w"> </span><span class="nf">check_user_subscription</span><span class="p">(</span><span class="n">user</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">check_user_subscription</span><span class="p">(</span><span class="n">user</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Check if a user is subscribed to the work unit database.</span>
 
@@ -280,10 +280,15 @@ <h1>Source code for xboinc.df_wu</h1><div class="highlight"><pre>
 
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
-<span class="sd">    bool</span>
-<span class="sd">        True if the user is subscribed, False otherwise.</span>
+<span class="sd">    str</span>
+<span class="sd">        The status of the user if subscribed, &quot;not_subscribed&quot; otherwise,</span>
+<span class="sd">        &quot;broken&quot; if the user&#39;s directory is invalid.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">query_subscribed_users</span><span class="p">()</span></div>
+    <span class="n">users</span> <span class="o">=</span> <span class="n">query_subscribed_users</span><span class="p">()</span>
+    <span class="k">for</span> <span class="n">u</span><span class="p">,</span> <span class="n">status</span> <span class="ow">in</span> <span class="n">users</span><span class="p">:</span>
+        <span class="k">if</span> <span class="n">u</span> <span class="o">==</span> <span class="n">user</span><span class="p">:</span>
+            <span class="k">return</span> <span class="n">status</span>
+    <span class="k">return</span> <span class="s2">&quot;not_subscribed&quot;</span></div>
 
 </pre></div>
 

_modules/xboinc/general.html

@@ -144,7 +144,7 @@ <h1>Source code for xboinc.general</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="__version__">
 <a class="viewcode-back" href="../../api/xboinc/index.html#xboinc.general.__version__">[docs]</a>
-<span class="n">__version__</span> <span class="o">=</span> <span class="s1">&#39;0.4.2&#39;</span></div>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s1">&#39;0.4.3&#39;</span></div>
 
 
 <span class="c1"># These are the xsuite modules that are used by boinc and the versions they are</span>

_modules/xboinc/retrieve.html

@@ -238,13 +238,22 @@ <h1>Source code for xboinc.retrieve</h1><div class="highlight"><pre>
                 <span class="n">job_name</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
                 <span class="n">wu_name</span> <span class="o">=</span> <span class="n">bin_file</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;.bin&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
                 <span class="c1"># append to the DataFrame</span>
-                <span class="n">new_row</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">([{</span>
-                    <span class="s2">&quot;user&quot;</span><span class="p">:</span> <span class="n">user</span><span class="p">,</span>
-                    <span class="s2">&quot;study_name&quot;</span><span class="p">:</span> <span class="n">study_name</span><span class="p">,</span>
-                    <span class="s2">&quot;job_name&quot;</span><span class="p">:</span> <span class="n">job_name</span><span class="p">,</span>
-                    <span class="s2">&quot;wu_name&quot;</span><span class="p">:</span> <span class="n">wu_name</span><span class="p">,</span>
-                    <span class="s2">&quot;bin_file&quot;</span><span class="p">:</span> <span class="n">bin_file</span><span class="p">,</span>
-                <span class="p">}])</span>
+                <span class="n">new_row</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span>
+                    <span class="p">[</span>
+                        <span class="p">{</span>
+                            <span class="s2">&quot;user&quot;</span><span class="p">:</span> <span class="n">user</span><span class="p">,</span>
+                            <span class="s2">&quot;study_name&quot;</span><span class="p">:</span> <span class="n">study_name</span><span class="p">,</span>
+                            <span class="s2">&quot;job_name&quot;</span><span class="p">:</span> <span class="n">job_name</span><span class="p">,</span>
+                            <span class="s2">&quot;wu_name&quot;</span><span class="p">:</span> <span class="n">wu_name</span><span class="p">,</span>
+                            <span class="s2">&quot;bin_file&quot;</span><span class="p">:</span> <span class="n">bin_file</span><span class="p">,</span>
+                            <span class="s2">&quot;json_file&quot;</span><span class="p">:</span> <span class="n">bin_file</span><span class="o">.</span><span class="n">with_name</span><span class="p">(</span>
+                                <span class="n">bin_file</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
+                                    <span class="s2">&quot;__file_xboinc_state_out.bin&quot;</span><span class="p">,</span> <span class="s2">&quot;.json&quot;</span>
+                                <span class="p">)</span>
+                            <span class="p">),</span>
+                        <span class="p">}</span>
+                    <span class="p">]</span>
+                <span class="p">)</span>
                 <span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">concat</span><span class="p">([</span><span class="n">df</span><span class="p">,</span> <span class="n">new_row</span><span class="p">],</span> <span class="n">ignore_index</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">df</span></div>
 
@@ -460,8 +469,8 @@ <h1>Source code for xboinc.retrieve</h1><div class="highlight"><pre>
 
 <span class="sd">        Yields</span>
 <span class="sd">        ------</span>
-<span class="sd">        tuple of (str, xpart.Particles)</span>
-<span class="sd">            Job name and corresponding particles object for each result</span>
+<span class="sd">        tuple of (str, dict, xpart.Particles)</span>
+<span class="sd">            Job name, corresponding metadata, and particles object for each result</span>
 
 <span class="sd">        Raises</span>
 <span class="sd">        ------</span>
@@ -485,6 +494,7 @@ <h1>Source code for xboinc.retrieve</h1><div class="highlight"><pre>
         <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_df</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_df</span><span class="p">[</span><span class="s2">&quot;study_name&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">study_name</span><span class="p">]</span><span class="o">.</span><span class="n">itertuples</span><span class="p">():</span>
             <span class="n">job_name</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">job_name</span>
             <span class="n">bin_file</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">bin_file</span>
+            <span class="n">json_file</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">json_file</span>
             <span class="n">result</span> <span class="o">=</span> <span class="n">XbState</span><span class="o">.</span><span class="n">from_binary</span><span class="p">(</span><span class="n">bin_file</span><span class="p">,</span> <span class="n">raise_version_error</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
             <span class="k">if</span> <span class="n">result</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
                 <span class="n">warn</span><span class="p">(</span>
@@ -493,7 +503,22 @@ <h1>Source code for xboinc.retrieve</h1><div class="highlight"><pre>
                     <span class="ne">UserWarning</span><span class="p">,</span>
                 <span class="p">)</span>
                 <span class="k">continue</span>
-            <span class="k">yield</span> <span class="n">job_name</span><span class="p">,</span> <span class="n">result</span><span class="o">.</span><span class="n">particles</span></div>
+            <span class="k">try</span><span class="p">:</span>
+                <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">json_file</span><span class="p">,</span> <span class="s2">&quot;r&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
+                    <span class="n">metadata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
+                <span class="c1"># is metadata an empty dict?</span>
+                <span class="k">if</span> <span class="ow">not</span> <span class="n">metadata</span><span class="p">:</span>
+                    <span class="n">warn</span><span class="p">(</span>
+                        <span class="sa">f</span><span class="s2">&quot;Warning: The JSON file </span><span class="si">{</span><span class="n">json_file</span><span class="si">}</span><span class="s2"> is empty.&quot;</span><span class="p">,</span>
+                        <span class="ne">UserWarning</span><span class="p">,</span>
+                    <span class="p">)</span>
+            <span class="k">except</span> <span class="ne">FileNotFoundError</span><span class="p">:</span>
+                <span class="n">warn</span><span class="p">(</span>
+                    <span class="sa">f</span><span class="s2">&quot;Warning: The JSON file </span><span class="si">{</span><span class="n">json_file</span><span class="si">}</span><span class="s2"> was not found.&quot;</span><span class="p">,</span>
+                    <span class="ne">UserWarning</span><span class="p">,</span>
+                <span class="p">)</span>
+                <span class="n">metadata</span> <span class="o">=</span> <span class="p">{}</span>
+            <span class="k">yield</span> <span class="n">job_name</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">result</span><span class="o">.</span><span class="n">particles</span></div>
 
 
 <div class="viewcode-block" id="JobRetriever.clean">
@@ -526,6 +551,9 @@ <h1>Source code for xboinc.retrieve</h1><div class="highlight"><pre>
             <span class="n">bin_file</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">bin_file</span>
             <span class="k">if</span> <span class="n">bin_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
                 <span class="n">bin_file</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
+            <span class="n">json_file</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">json_file</span>
+            <span class="k">if</span> <span class="n">json_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+                <span class="n">json_file</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
         <span class="c1"># Remove empty directories</span>
         <span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_directory</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s2">&quot;*/&quot;</span><span class="p">):</span>
             <span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">folder</span><span class="o">.</span><span class="n">iterdir</span><span class="p">()):</span>

_sources/api/xboinc/df_wu/index.rst.txt

@@ -76,22 +76,23 @@ Module Contents
    :rtype: pd.DataFrame
 
 
-.. py:function:: query_subscribed_users() -> list[str]
+.. py:function:: query_subscribed_users() -> list[tuple[str, str]]
 
-   Get a list of all users subscribed to the work unit database.
+   Get a list of all users subscribed to the work unit database with their status.
 
-   :returns: List of usernames subscribed to the work unit database.
-   :rtype: list[str]
+   :returns: List of tuples containing (username, status) for users subscribed to the work unit database.
+   :rtype: list[tuple[str, str]]
 
 
-.. py:function:: check_user_subscription(user: str) -> bool
+.. py:function:: check_user_subscription(user: str) -> str
 
    Check if a user is subscribed to the work unit database.
 
    :param user: The username to check.
    :type user: str
 
-   :returns: True if the user is subscribed, False otherwise.
-   :rtype: bool
+   :returns: The status of the user if subscribed, "not_subscribed" otherwise,
+             "broken" if the user's directory is invalid.
+   :rtype: str
 
 

_sources/api/xboinc/general/index.rst.txt

@@ -20,7 +20,7 @@ Module Contents
 .. py:data:: _pkg_root
 
 .. py:data:: __version__
-   :value: '0.4.2'
+   :value: '0.4.3'
 
 
 .. py:data:: __xsuite__versions__

_sources/api/xboinc/index.rst.txt

@@ -62,15 +62,16 @@ Functions
 Package Contents
 ----------------
 
-.. py:function:: check_user_subscription(user: str) -> bool
+.. py:function:: check_user_subscription(user: str) -> str
 
    Check if a user is subscribed to the work unit database.
 
    :param user: The username to check.
    :type user: str
 
-   :returns: True if the user is subscribed, False otherwise.
-   :rtype: bool
+   :returns: The status of the user if subscribed, "not_subscribed" otherwise,
+             "broken" if the user's directory is invalid.
+   :rtype: str
 
 
 .. py:function:: query_registered_work_units(status: Optional[str] = None, dev_server: bool = False) -> pandas.DataFrame
@@ -123,7 +124,7 @@ Package Contents
 
 
 .. py:data:: __version__
-   :value: '0.4.2'
+   :value: '0.4.3'
 
 
 .. py:data:: __xsuite__versions__
@@ -316,7 +317,7 @@ Package Contents
       :param study_name: Name of the study to iterate over
       :type study_name: str
 
-      :Yields: *tuple of (str, xpart.Particles)* -- Job name and corresponding particles object for each result
+      :Yields: *tuple of (str, dict, xpart.Particles)* -- Job name, corresponding metadata, and particles object for each result
 
       :raises ValueError: If study_name is not found in available results
 

_sources/api/xboinc/retrieve/index.rst.txt

@@ -166,7 +166,7 @@ Module Contents
       :param study_name: Name of the study to iterate over
       :type study_name: str
 
-      :Yields: *tuple of (str, xpart.Particles)* -- Job name and corresponding particles object for each result
+      :Yields: *tuple of (str, dict, xpart.Particles)* -- Job name, corresponding metadata, and particles object for each result
 
       :raises ValueError: If study_name is not found in available results