Merge pull request #29 from xsuite/release/v0.5.0

Release 0.5.0

Author: freddieknets

README.md

@@ -2,8 +2,6 @@
 
 Xboinc is a package within the Xsuite project that provides tools for easily submit and manage tracking jobs on the BOINC computing platform. It is designed to streamline the process of job submission, management, and monitoring for users of the Xsuite framework in need for large-scale computing resources, with a project adaptable to volunteer-based computing. Note that the services provided by this package are available only to CERN users with a valid computing account.
 
-**NOTE: CURRENTLY, ONLY THE DEVELOPMENT SERVER IS AVAILABLE! Be sure to always set the `dev_server` parameter to `True` when using the package!**
-
 # How to use Xboinc
 
 ## Install Xboinc
@@ -81,7 +79,7 @@ job_manager = xb.JobSubmitter(
     user="mycernshortname",
     study_name="a_relevant_study_name",
     line=line,
-    dev_server=True # currently, the dev server is the only one available
+    dev_server=False, # set to True to use the Xboinc development server (for testing purposes only), by default False
 )
 
 # prepare a big batch of particles
@@ -114,7 +112,7 @@ When the jobs are completed, the Xboinc server will store the results in your al
 ```python
 import xboinc as xb
 
-for job_name, job_metadata, result_particles in xb.JobRetriever.iterate("mycernshortname", "a_relevant_study_name", dev_server=True):
+for job_name, job_metadata, result_particles in xb.JobRetriever.iterate("mycernshortname", "a_relevant_study_name"):
     print(f"Job {job_name} completed with particles: {result_particles.to_dict()}")
     print(f"Job metadata: {job_metadata}")
 
@@ -132,7 +130,7 @@ print(xb.check_user_subscription("mycernshortname"))
 # Query the registered work units for the user
 print("What are my jobs?")
 # Probes the work units for the user registered in this Xboinc installation
-print(xb.query_registered_work_units(dev_server=True))
+print(xb.query_registered_work_units())
 ```
 
 Other convenience functions are available in the `xboinc` package, be sure to inspect the API documentation and docstrings for more details! 

pin_xsuite_versions.sh

@@ -22,12 +22,10 @@ cd ..
 echo "The following modules will be pinned:"
 for module in $modules; do
     version=$(python -c "import $module; print($module.__version__)")
-    
     if [[ -z "$version" ]]; then
         echo "Error: Could not retrieve version for $module"
         exit 1
     fi
-    
     echo "  - ${module}: $version"
 done
 
@@ -49,19 +47,33 @@ esac
 echo "Updating version information in configuration files..."
 for module in $modules; do
     version=$(python -c "import $module; print($module.__version__)")
-    
     if [[ -z "$version" ]]; then
         echo "Error: Could not retrieve version for $module"
         exit 1
     fi
-    
-    # Update version in three different files with appropriate patterns
-    sed -i "s/\('${module}' *:\).*/\1 '${version}',/"  xboinc/general.py
-    sed -i "s/\('${module}' *:\).*/\1 '${version}',/"  tests/test_version.py
-    sed -i "s/\(${module} *=\).*/\1 '==${version}'/"   pyproject.toml
-    
+    if [[ "$OSTYPE" == "darwin"* ]]
+    then
+        # Update version in three different files with appropriate patterns
+        sed -i '' "s/\('"${module}"' *:\).*/\1 '"${version}"',/"  xboinc/general.py
+        sed -i '' "s/\("${module}" *=\).*/\1 '=="${version}"'/"   pyproject.toml
+        sed -i '' "s/\('"${module}"' *:\).*/\1 '"${version}"'/"   tests/test_version.py
+    else
+        # Update version in three different files with appropriate patterns
+        sed -i "s/\('"${module}"' *:\).*/\1 '"${version}"',/"  xboinc/general.py
+        sed -i "s/\("${module}" *=\).*/\1 '=="${version}"'/"   pyproject.toml
+        sed -i "s/\('"${module}"' *:\).*/\1 '"${version}"'/"   tests/test_version.py
+    fi
     echo "  - Pinned ${module} to version ${version}"
 done
 
+# ----- Update app version in C source -----
+appver=$(python -c "import xboinc; print(xboinc.app_version_int)")
+if [[ "$OSTYPE" == "darwin"* ]]
+then
+    sed -i '' "s/\(int64_t xboinc_exec_version =\).*/\1 "${appver}";/" xboinc/executable/version.h
+else
+    sed -i "s/\(int64_t xboinc_exec_version =\).*/\1 "${appver}";/" xboinc/executable/version.h
+fi
+
 echo "Version pinning completed successfully."
 exit 0

pyproject.toml

@@ -5,7 +5,7 @@
 
 [tool.poetry]
 name = "xboinc"
-version = "0.4.3"
+version = "0.5.0"
 description = "Xsuite BOINC interface"
 homepage = "https://github.com/xsuite/xboinc"
 repository = "https://github.com/xsuite/xboinc"
@@ -24,7 +24,7 @@ include = [ "LICENSE", "NOTICE" ]
 python    = '>=3.9'
 numpy     = '>=1.0'
 packaging = '>=23.0'
-xobjects  = ">=0.5.0"
+xobjects  = ">=0.5.3"
 xdeps     = '==0.10.5'
 xpart     = '==0.23.0'
 xtrack    = '==0.84.7'

tests/test_version.py

@@ -12,7 +12,7 @@
 
 
 def test_version():
-    assert __version__ == '0.4.3'
+    assert __version__ == '0.5.0'
 
 
 def test_xb_ver():

xboinc/executable/main.cpp

@@ -13,11 +13,13 @@
 
 #ifdef __cplusplus
 #include <cstdio>
+#include <chrono>
 #include <cstdint>
 #include <cstdlib>
 #include <cstring>
 #include <cmath>
 #include <cstdarg>
+#include <functional>
 #else
 #include <stdio.h>
 #include <stdint.h>
@@ -73,7 +75,7 @@ int8_t early_sleep = 0;
 int8_t trickle_up = 0;
 int8_t trickle_down = 0;
 int8_t critical_section = 0;    // run most of the time in a critical section
-int8_t report_fraction_done = 0;
+int8_t report_fraction_done = 1;
 int8_t network_usage = 0;
 double cpu_time = 20, comp_result;
 int8_t verbose = 0;
@@ -85,6 +87,70 @@ static FILE*   XB_fopen_allow_null(char *filename, const char *mode);
 static int8_t* XB_file_to_buffer(FILE *fid, int8_t *buf_in);
 static int     XB_do_checkpoint(XbInput xb_input, XbState xb_state);
 
+class ThrottledReporter
+{
+public:
+    using Clock = std::chrono::steady_clock;
+
+    // interval: minimum time between reports
+    // report:   void(double fraction_done)
+    // check_every: only check the clock every N calls (must be power of two for fast masking)
+    // report_first: if true, allow the very first call to report immediately
+    ThrottledReporter(std::chrono::seconds interval,
+                      std::function<void(double)> report,
+                      uint32_t check_every = 32,
+                      bool report_first = true)
+        : interval_(interval),
+          report_(std::move(report)),
+          mask_(check_every - 1),
+          report_first_(report_first),
+          last_(Clock::now())
+    {
+        // Ensure check_every is a power of two (optional assert in debug)
+        // assert((check_every & (check_every - 1)) == 0 && "check_every must be power of two");
+        if (report_first_)
+            last_ -= interval_; // so first eligible call will pass immediately
+    }
+
+    inline void maybe_report(double fraction_done)
+    {
+        // Amortize clock reads
+        if ((++calls_ & mask_) != 0)
+            return;
+
+        auto now = Clock::now();
+        if (now - last_ >= interval_)
+        {
+            last_ = now;
+            report_(fraction_done);
+        }
+    }
+
+    // If you want to force a final update at the end:
+    inline void flush(double fraction_done)
+    {
+        report_(fraction_done);
+        last_ = Clock::now();
+    }
+
+private:
+    std::chrono::seconds interval_;
+    std::function<void(double)> report_;
+    uint32_t mask_;
+    bool report_first_;
+    Clock::time_point last_;
+    uint32_t calls_ = 0;
+};
+
+ThrottledReporter prog(std::chrono::seconds(1), [](double fd)
+                       {
+                           XB_fprintf(2, stdout, "Percentage done: %f%%\n", fd * 100.);
+#ifdef COMPILE_TO_BOINC
+                           boinc_fraction_done(fd);
+#endif
+                       },
+                       /*check_every=*/32, // read the clock every 32 iterations
+                       /*report_first=*/true);
 
 int main(int argc, char **argv){
     int retval;
@@ -258,13 +324,9 @@ int main(int argc, char **argv){
             boinc_checkpoint_completed();
 #endif
         }
-#ifdef COMPILE_TO_BOINC
         if (report_fraction_done) {
-            double fd = (int)current_turn / (int)num_turns;
-            if (cpu_time) fd /= 2;
-            boinc_fraction_done(fd);
+            prog.maybe_report((double)current_turn / (double)num_turns);
         }
-#endif
     }
     // End main loop  ===========
     // ==========================
@@ -276,6 +338,7 @@ int main(int argc, char **argv){
            XbInput_get_xb_state__xsize(xb_input), outfile);
     fclose(outfile);
 
+    prog.flush(1.0);
 #ifdef COMPILE_TO_BOINC
     // BOINC clean up
     // if (trickle_up) {
@@ -289,7 +352,7 @@ int main(int argc, char **argv){
     //         XB_fprintf(0, stderr, "Got trickle-down message: %s\n", buf);
     //     }
     // }
-    boinc_fraction_done(1);
+    // boinc_fraction_done(1);
     boinc_finish(0);
 #endif
 

xboinc/executable/version.h

@@ -19,7 +19,7 @@
 // Do not change
 // =============================================================================
 // version XXX.YYY as int  (no patch)
-const int64_t xboinc_exec_version = 4;
+const int64_t xboinc_exec_version = 5;
 // =============================================================================
 
 #endif /* XB_EXECUTABLE_VERSION_H */

xboinc/general.py

@@ -12,7 +12,7 @@
 # Do not change
 # ==============================================================================
 
-__version__ = '0.4.3'
+__version__ = '0.5.0'
 
 # These are the xsuite modules that are used by boinc and the versions they are
 # tied to. This will be automatically updated from the active environment when

xboinc/submit.py

@@ -152,10 +152,10 @@ def __init__(self, user, study_name, line=None, dev_server=False, **kwargs):
         """
 
         assert_versions()
-        if not dev_server:
-            raise NotImplementedError(
-                "Regular server not yet operational. " + "Please use dev_server=True."
-            )
+        # if not dev_server:
+        #     raise NotImplementedError(
+        #         "Regular server not yet operational. " + "Please use dev_server=True."
+        #     )
         self.dev_server = dev_server
         if "__" in study_name:
             raise ValueError(