Changeset 1146 for framspy/frams.py

Timestamp:

08/03/21 14:00:12 (20 months ago)

Author:

Maciej Komosinski

Message:

Cosmetic

File:

• framspy/frams.py (modified) (3 diffs)

framspy/frams.py

@@ -14 +14 @@
 
 For sample usage, see frams-test.py and FramsticksLib.py.
+
+If you want to run many independent instances of this class in parallel, use the "multiprocessing" module and then each process
+that uses this module will initialize it and get access to a separate instance of the Framsticks library.
 
 For interfaces in other languages (e.g. using the Framsticks library in your C++ code), see ../cpp/frams/frams-objects.h
@@ -285 +288 @@
 
         original_dir = os.getcwd()
-        os.chdir(lib_path)  # because under Windows, frams-objects.dll requires other dll's which reside in the same directory, so we must change current dir for them to be found while loading the main dll
+        os.chdir(lib_path)  # because under Windows, frams-objects.dll requires other dll's which reside in the same directory, so we must change current dir for them to be found while loading the main dll.
+        # TODO in python 3.8+ and Windows, use os.add_dll_directory(lib_path) instead of os.chdir()? And maybe for linux we no longer need chdir() and "./", but use absolute path?
         abs_data = os.path.abspath('data')  # use absolute path for -d and -D so python is free to cd anywhere without confusing Framsticks
         # for the hypothetical case without lib_path the abs_data must be obtained from somewhere else
@@ -298 +302 @@
         global c_api  # access global variable
         if lib_path is not None and os.name == 'posix':
-                lib_name = './' + lib_name  # currently we always have lib_path (even if it is incorrect) but hypothetically it could work with lib_path==None and load .so from some default system path without './'
+                lib_name = './' + lib_name  # currently we always have lib_path (even if it is incorrect), but hypothetically it could work with lib_path==None and then load .so from some default system path without './'
         try:
-                c_api = ctypes.CDLL(lib_name)  # should be a separate instance and no globals if we want multiple threads to use this module (todo?)
+                c_api = ctypes.CDLL(lib_name)  # if accessing this module from multiple threads, they will all share a single c_api and access the same copy of the library and its data. If you want separate independent copies, read the comment at the top of this file on using the "multiprocessing" module.
         except OSError as e:
                 print("*** Could not find or open '%s' from '%s'.\n*** Did you provide proper arguments and is this file readable?\n" % (lib_name, os.getcwd()))