Difference between revisions of "Poclbm"

From Bitcoin Wiki
Jump to: navigation, search
(See Also: Add to See Also an entry for pooled mining.)
(Updated links)
 
(25 intermediate revisions by 16 users not shown)
Line 1: Line 1:
Poclbm (PyOpenCL bitcoin miner) is a python GPU bitcoin miner that uses the [[OpenCL miner|OpenCL]] framework to quickly perform the hashing computations.  Works with AMD - 4xxx and up, Nvidia - 8xxx and up, video cards.
+
'''poclbm''' ('''Python OpenCL bitcoin miner''') was a program that used the [[OpenCL miner|OpenCL]] framework to allow [[mining]] on a graphics card. It was the first open source GPU mining software to be produced.
  
 
==Download==
 
==Download==
[http://github.com/downloads/m0mchil/poclbm/poclbm_py2exe_20110104.7z Latest miner.]
+
*[https://github.com/downloads/m0mchil/poclbm/poclbm_py2exe_20120920.7z Latest miner]<!-- (MD5 SUM: todo)-->
 +
*[https://github.com/m0mchil/poclbm/ Sources]
  
[https://github.com/m0mchil/poclbm/archives/master Sources.]
+
==Flags to Use==
 +
 
 +
===Flags List===
 +
{| class="wikitable"
 +
|-
 +
!  Command line flags  !! Flags descriptions
 +
|-
 +
| -version || Show program's version number and exit
 +
|-
 +
|  -h, --help || Show help message and exit
 +
|-
 +
| -u USER, --user=USER || Set user name
 +
|-
 +
| --pass=PASSWORD || Set password
 +
|-
 +
| -o HOST, --host=HOST || Set RPC host (without 'http://')
 +
|-
 +
| -p PORT, --port=PORT || Set RPC port
 +
|-
 +
| -r RATE, --rate=RATE || Set hash rate display interval in seconds, default=1
 +
|-
 +
| -f FRAMES, --frames=FRAMES || Will try to bring single kernel execution to 1/frames seconds, default=30. Increase this for less desktop lag
 +
|-
 +
| -d DEVICE, --device=DEVICE || Set used device by id, by default asks for device
 +
|-
 +
| -a ASKRATE, --askrate=ASKRATE || Set how many seconds between getwork requests, default 5, max 10
 +
|-
 +
| -w WORKSIZE, --worksize=WORKSIZE || Set work group size, default is maximum returned by opencl
 +
|-
 +
| -v, --vectors || Enable vectors, which is faster on some cards.
 +
|-
 +
| --verbose || Enable verbose output, suitable for redirection to log file
 +
|-
 +
| --platform=PLATFORM || Set used platform by id
 +
|-
 +
| -s SLEEPTIME || Sleep for the specified number of seconds between iterations (default 0). Increase this to reduce hashing performance if your temperatures are too high.
 +
|}
  
==Flags to Use==
+
===Usage Tips===
  
 
ATI/AMD Radeon HD 5xxx cards (for example, HD 5770): use '-v -w128'
 
ATI/AMD Radeon HD 5xxx cards (for example, HD 5770): use '-v -w128'
 +
 +
('-v -f10 -w128' works even better for HD5770.)
  
 
If you find the desktop laggy while mining, use '-f60'. This may decrease performance slightly.
 
If you find the desktop laggy while mining, use '-f60'. This may decrease performance slightly.
Line 15: Line 54:
  
 
==FAQ==
 
==FAQ==
[http://www.bitcoin.org/smf/index.php?topic=1334.msg14875#msg14875 Introductory post FAQ.]
+
[https://bitcointalk.org/index.php?topic=1334.0 Introductory post FAQ.]
  
 
==Founder==
 
==Founder==
[http://www.bitcoin.org/smf/index.php?action=profile;u=33 m0mchil]
+
[https://bitcointalk.org/index.php?action=profile;u=33 m0mchil]
  
==Guides==
+
==Guides and Installation==
  
 
===Windows===
 
===Windows===
Line 26: Line 65:
  
 
===Ubuntu===
 
===Ubuntu===
[http://www.bitcoin.org/smf/index.php?topic=2636 Easy Ubuntu python OpenCL mining setup]
+
[https://www.bitcointalk.org/?topic=2636 Easy Ubuntu python OpenCL mining setup]
 +
 
 +
===Gentoo===
 +
An poclbm ebuild can be found in the [[Gentoo|Gentoo Bitcoin]] overlay [https://gitorious.org/bitcoin/gentoo here]
 +
 
 +
===OpenSUSE===
 +
 
 +
This works on 11.4, 12.1 and should work on other versions - just replace the "12.1" in the repo URLs with your version number. This also assumes that you are already familiar with running getting the BitCoin client running (to run the GUI version on OpenSUSE you will need `libqt4-x11` or `libqt4-x11-32bit` installed).
 +
 
 +
Add the Python devel repo:
 +
 
 +
<code># zypper ar -r http://download.opensuse.org/repositories/devel:/languages:/python/openSUSE_12.1/devel:languages:python.repo</code>
 +
 
 +
and this user repo, which provides PyOpenCL (take a moment to appreciate this because if "scorot" didn't package it this would be a lot harder):
 +
 
 +
<code># zypper ar -r http://download.opensuse.org/repositories/home:/scorot/openSUSE_12.1/home:scorot.repo</code>
 +
 
 +
and finally this repo, which is needed for the previous to work (replace i586 with x86_64 if you're 64-bit):
 +
 
 +
<code># zypper ar -r http://download.nvidia.com/opensuse/12.1/ nvidia-i586</code>
 +
 
 +
Refresh your repos:
 +
 
 +
<code># zypper ref</code>
 +
 
 +
You will asked to accept the repo keys, respond with 'a' each time.
 +
 
 +
Install PyOpenCL:
 +
 
 +
<code># zypper in python-opencl</code>
 +
 
 +
Get the latest version of poclbm with git (`zypper in git-core` if you don't have git installed):
 +
 
 +
<code>$ git clone git://github.com/m0mchil/poclbm.git</code>
 +
 
 +
This will create a poclbm folder in your current directory. Change to it:
 +
 
 +
<code>$ cd poclbm</code>
 +
 
 +
And run it:
 +
 
 +
<code>$ python poclbm.py --device=0 http://user:pass@api.example.org:8332 [add whatever other flags you use]</code>
  
 
==License==
 
==License==
Open source, but no mention of which open source license was found.
+
public domain<ref name="license">[http://github.com/m0mchil/poclbm/blob/master/LICENSE License file on github]</ref>
  
 
==See Also==
 
==See Also==
  
 
* [[poclbm-gui]] GUI frontend
 
* [[poclbm-gui]] GUI frontend
 +
* A highly efficient version: [[poclbm-mod]] by [[Bitcoin Pool]]
 
* [[Pooled mining]]
 
* [[Pooled mining]]
 
* [[Why a GPU mines faster than a CPU]]
 
* [[Why a GPU mines faster than a CPU]]
Line 40: Line 121:
  
 
* [http://github.com/m0mchil/poclbm  Poclbm] project page on GitHub
 
* [http://github.com/m0mchil/poclbm  Poclbm] project page on GitHub
* [http://www.bitcoin.org/smf/index.php?topic=1334.0 Project Thread]
+
* [https://bitcointalk.org/index.php?topic=1334 Project Thread]
 +
* [http://www.bitcoinmining.com/bitcoin-mining-software/ Bitcoin Mining Software]
 +
 
 +
==References==
 +
<references />
  
[[Category:Mining]]
+
[[Category:Miners]]
 
[[Category:Free Software]]
 
[[Category:Free Software]]
 
[[Category:License/Public Domain]]
 
[[Category:License/Public Domain]]
 
[[Category:Open Source]]
 
[[Category:Open Source]]
 +
{{lowercase}}

Latest revision as of 21:07, 10 December 2015

poclbm (Python OpenCL bitcoin miner) was a program that used the OpenCL framework to allow mining on a graphics card. It was the first open source GPU mining software to be produced.

Download

Flags to Use

Flags List

Command line flags Flags descriptions
-version Show program's version number and exit
-h, --help Show help message and exit
-u USER, --user=USER Set user name
--pass=PASSWORD Set password
-o HOST, --host=HOST Set RPC host (without 'http://')
-p PORT, --port=PORT Set RPC port
-r RATE, --rate=RATE Set hash rate display interval in seconds, default=1
-f FRAMES, --frames=FRAMES Will try to bring single kernel execution to 1/frames seconds, default=30. Increase this for less desktop lag
-d DEVICE, --device=DEVICE Set used device by id, by default asks for device
-a ASKRATE, --askrate=ASKRATE Set how many seconds between getwork requests, default 5, max 10
-w WORKSIZE, --worksize=WORKSIZE Set work group size, default is maximum returned by opencl
-v, --vectors Enable vectors, which is faster on some cards.
--verbose Enable verbose output, suitable for redirection to log file
--platform=PLATFORM Set used platform by id
-s SLEEPTIME Sleep for the specified number of seconds between iterations (default 0). Increase this to reduce hashing performance if your temperatures are too high.

Usage Tips

ATI/AMD Radeon HD 5xxx cards (for example, HD 5770): use '-v -w128'

('-v -f10 -w128' works even better for HD5770.)

If you find the desktop laggy while mining, use '-f60'. This may decrease performance slightly.

Please update this section if you find better settings, or good settings for a card not listed here.

FAQ

Introductory post FAQ.

Founder

m0mchil

Guides and Installation

Windows

How to get started using your GPU to mine for Bitcoins on Windows

Ubuntu

Easy Ubuntu python OpenCL mining setup

Gentoo

An poclbm ebuild can be found in the Gentoo Bitcoin overlay here

OpenSUSE

This works on 11.4, 12.1 and should work on other versions - just replace the "12.1" in the repo URLs with your version number. This also assumes that you are already familiar with running getting the BitCoin client running (to run the GUI version on OpenSUSE you will need `libqt4-x11` or `libqt4-x11-32bit` installed).

Add the Python devel repo:

# zypper ar -r http://download.opensuse.org/repositories/devel:/languages:/python/openSUSE_12.1/devel:languages:python.repo

and this user repo, which provides PyOpenCL (take a moment to appreciate this because if "scorot" didn't package it this would be a lot harder):

# zypper ar -r http://download.opensuse.org/repositories/home:/scorot/openSUSE_12.1/home:scorot.repo

and finally this repo, which is needed for the previous to work (replace i586 with x86_64 if you're 64-bit):

# zypper ar -r http://download.nvidia.com/opensuse/12.1/ nvidia-i586

Refresh your repos:

# zypper ref

You will asked to accept the repo keys, respond with 'a' each time.

Install PyOpenCL:

# zypper in python-opencl

Get the latest version of poclbm with git (`zypper in git-core` if you don't have git installed):

$ git clone git://github.com/m0mchil/poclbm.git

This will create a poclbm folder in your current directory. Change to it:

$ cd poclbm

And run it:

$ python poclbm.py --device=0 http://user:pass@api.example.org:8332 [add whatever other flags you use]

License

public domain[1]

See Also

External Links

References