Prep 1.0.0 release. Install OpenCL support by default.

Author: JustinTArthur

README.md

@@ -1,32 +1,42 @@
 # apoclypsebm - The ApoCLypse Bitcoin Miner
 ## Background
-This hobby project undertakes the quixotic task of maintaining a modern Bitcoin miner for programmable compute
+This hobby project maintained by [Justin T. Arthur](https://github.com/JustinTArthur) undertakes the quixotic task of maintaining a modern Bitcoin miner for programmable compute
 devices like GPUs. It was forked from the PyOpenCL Bitcoin Miner (poclbm), a project authored by 
-[m0mchil](https://github.com/m0mchil/) and contributors.
+[m0mchil](https://github.com/m0mchil) and contributors.
 
 It features an OpenCL Kernel that has incorporated ideas or code from:
-* [diapolo](https://github.com/diapolo/)
-* [m0mchil](https://github.com/m0mchil/)
+* [diapolo](https://github.com/diapolo)
+* [m0mchil](https://github.com/m0mchil)
 * [neurobox](https://bitcointalk.org/index.php?action=profile;u=106397)
 * [phataeus](https://sourceforge.net/u/phateus/)
 * [rethaw](https://bitcointalk.org/index.php?action=profile;u=18618)
 
 If your work is represented herein and I didn't give you credit, please let me know. At the moment, I reserve no rights
 to the mining driver or the OpenCL kernel. They were derived from public domain works.
 
+## New in Version 1.0.0
+* First release following the fork from [m0mchil/poclbm](https://github.com/m0mchil/poclbm). ([diff](https://github.com/m0mchil/poclbm/compare/master...JustinTArthur:v1.0.0))
+* Migrated code to Python 3. Requires Python 3.5+
+* Fix kernel compilation error in clang-based OpenCL compilers like macOS OpenCL and
+AMD ROCm.
+* Fix for not submitting shares to stratum servers reporting pdifficulty when server-side pdifficulty is below 1. By [luke-jr](https://github.com/luke-jr).
+* Minor performance improvements
+
 ## Economy
-At the time of this writing, on-chip implementations of the Bitcoin mining solution algorithm will outperform this
-software in time and joules expended. Under most economic conditions, mining blocks on a Bitcoin chain where
-on-chip implementations are competing would be at tremendous waste of expended resources.
+At the time of writing, on-chip implementations of the Bitcoin mining algorithm will outperform this
+software in both time and joules expended. Under most conditions, mining blocks on a Bitcoin chain where
+on-chip implementations are competing would be at a tremendous waste of expended resources.
 
 ## Installation
-    pip3 install git+git://github.com/JustinTArthur/apoclypsebm.git[OpenCL]
+Python 3.5+ must be installed first. To install latest from master branch on GitHub:
+
+    pip3 install git+git://github.com/JustinTArthur/apoclypsebm.git
 
 ## Usage
     apoclypse [OPTION]... SERVER[#tag]...
 
-`SERVER` is one or more [http[s]|stratum://]user:pass@host:port          (required)
-[#tag] is an optional per server user friendly name displayed in stats (optional)
+`SERVER` is one or more [http[s]|stratum://]user:pass@host:port          (required)  
+[#tag] is an optional per server user-friendly name displayed in stats.
 
 ### Options
 ```
@@ -37,6 +47,12 @@ on-chip implementations are competing would be at tremendous waste of expended r
   --proxy=PROXY         specify as
                         [[socks4|socks5|http://]user:pass@]host:port (default
                         proto is socks5)
+  --no-ocl              don't use OpenCL
+  --no-bfl              don't use Butterfly Labs
+  --stratum-proxies     search for and use stratum proxies in subnet
+  -d DEVICE, --device=DEVICE
+                        comma separated device IDs, by default will use all
+                        (for OpenCL - only GPU devices)
 
   Miner Options:
     -r RATE, --rate=RATE
@@ -45,36 +61,40 @@ on-chip implementations are competing would be at tremendous waste of expended r
     -e ESTIMATE, --estimate=ESTIMATE
                         estimated rate time window in seconds, default 900 (15
                         minutes)
-    -a ASKRATE, --askrate=ASKRATE
-                        how many seconds between getwork requests, default 5,
-                        max 10
     -t TOLERANCE, --tolerance=TOLERANCE
                         use fallback pool only after N consecutive connection
                         errors, default 2
     -b FAILBACK, --failback=FAILBACK
                         attempt to fail back to the primary pool after N
                         seconds, default 60
-    --cutoff_temp=CUTOFF_TEMP
-                        (requires github.com/mjmvisser/adl3) temperature at
-                        which to skip kernel execution, in C, default=95
-    --cutoff_interval=CUTOFF_INTERVAL
-                        (requires adl3) how long to not execute calculations
-                        if CUTOFF_TEMP is reached, in seconds, default=0.01
+    --cutoff-temp=CUTOFF_TEMP
+                        AMD GPUs, BFL only. For GPUs requires
+                        github.com/mjmvisser/adl3. Comma separated
+                        temperatures at which to skip kernel execution, in C,
+                        default=95
+    --cutoff-interval=CUTOFF_INTERVAL
+                        how long to not execute calculations if CUTOFF_TEMP is
+                        reached, in seconds, default=0.01
     --no-server-failbacks
                         disable using failback hosts provided by server
 
-  Kernel Options:
+  OpenCL Options:
+    Every option except '-p' and '-v' can be specified as a
+    comma separated list. If there aren't enough entries specified, the
+    last available is used. Use --vv to specify per-device vectors usage.
+
     -p PLATFORM, --platform=PLATFORM
-                        use OpenCL platform by id
-    -d DEVICE, --device=DEVICE
-                        use device by id, by default asks for device
+                        use platform by id
     -w WORKSIZE, --worksize=WORKSIZE
-                        work group size, default is maximum returned by opencl
+                        work group size, default is maximum returned by OpenCL
     -f FRAMES, --frames=FRAMES
                         will try to bring single kernel execution to 1/frames
                         seconds, default=30, increase this for less desktop
                         lag
     -s FRAMESLEEP, --sleep=FRAMESLEEP
                         sleep per frame in seconds, default 0
-    -v, --vectors       use 2-attempts-wide vectors on all devices
+    --vv=VECTORS        Specifies size of SIMD vectors per selected device.
+                        Only size 0 (no vectors) and 2 supported for now.
+                        Comma separated for each device. e.g. 0,2,2
+    -v, --vectors       Use 2-item vectors for all devices.
 ```

apoclypsebm/command.py

@@ -74,8 +74,8 @@ def __init__(self, family=socket.AF_INET, type=socket.SOCK_STREAM, proto=0):
                  help='will try to bring single kernel execution to 1/frames seconds, default=30, increase this for'
                       ' less desktop lag')
 group.add_option('-s', '--sleep', dest='frameSleep', default=[], help='sleep per frame in seconds, default 0')
-group.add_option('--vv', dest='vectors', default=[], help='use vectors, default false')
-group.add_option('-v', '--vectors', dest='old_vectors', action='store_true', help='use vectors')
+group.add_option('--vv', dest='vectors', default=[], help='Specifies size of SIMD vectors per selected device. Only size 0 (no vectors) and 2 supported for now. Comma separated for each device. e.g. 0,2,2')
+group.add_option('-v', '--vectors', dest='old_vectors', action='store_true', help='Use 2-item vectors for all devices.')
 parser.add_option_group(group)
 
 

apoclypsebm/version.py

@@ -1 +1 @@
-VERSION = '0.1.0'
+VERSION = '1.0.0'

setup.py

@@ -16,8 +16,7 @@
     'author': 'Justin T. Arthur',
     'author_email': 'justinarthur@gmail.com',
     'url': 'https://github.com/JustinTArthur/apoclypsebm/',
-    'install_requires': ('pyserial>=2.6', 'PySocks>=1.6.0'),
-    'extras_require': {'OpenCL': ("pyopencl>=2017.2",)},
+    'install_requires': ("pyopencl>=2017.2", 'pyserial>=2.6', 'PySocks>=1.6.0'),
     'entry_points': {
         'console_scripts': (
             'apoclypse = apoclypsebm.command:main',