diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 23 |
1 files changed, 11 insertions, 12 deletions
@@ -3,19 +3,18 @@ implementing erasure codes and is known to work with Python v2.6, 2.7 and 3.x. To obtain the best possible performance, the library utilizes liberasurecode,
which is a C based erasure code library. Please let us know if you have any
-other issues building or installing (email: kmgreen2@gmail.com or
-tusharsg@gmail.com).
+issues building or installing (email: kmgreen2@gmail.com or tusharsg@gmail.com).
-This library makes use of Jerasure for Reed-Solomon as implemented by the
-liberasurecode library and provides its' own flat XOR-based erasure code
-encoder and decoder. Currently, it implements a specific class of HD
-Combination Codes (see "Flat XOR-based erasure codes in storage systems:
-Constructions, efficient recovery, and tradeoffs" in IEEE MSST 2010). These
-codes are well-suited to archival use-cases, have a simple construction and
-require a minimum number of participating disks during single-disk
-reconstruction (think XOR-based LRC code).
+PyECLib supports a variety of Erasure Coding backends including the standard Reed
+Soloman implementations provided by Jerasure [2], liberasurecode [3] and Intel
+ISA-L [4]. It also provides support for a flat XOR-based encoder and decoder
+(part of liberasurecode) - a class of HD Combination Codes based on "Flat
+XOR-based erasure codes in storage systems: Constructions, efficient recovery,
+and tradeoffs" in IEEE MSST 2010). These codes are well-suited to archival
+use-cases, have a simple construction and require a minimum number of
+participating disks during single-disk reconstruction (think XOR-based LRC code).
-Examples of using this library are provided in "tools" directory:
+Examples of using PyECLib are provided in the "tools" directory:
Command-line encoder::
@@ -38,7 +37,7 @@ PyEClib initialization:: Supported ``ec_type`` values:
- * ``liberasurecode_rs_vand`` => Vandermonde Reed-Solomon encoding, native software-only backend
+ * ``liberasurecode_rs_vand`` => Vandermonde Reed-Solomon encoding, software-only backend implemented by liberasurecode [3]
* ``jerasure_rs_vand`` => Vandermonde Reed-Solomon encoding, based on Jerasure [1]
* ``jerasure_rs_cauchy`` => Cauchy Reed-Solomon encoding (Jerasure variant), based on Jerasure [2]
* ``flat_xor_hd_3``, ``flat_xor_hd_4`` => Flat-XOR based HD combination codes, liberasurecode [3]
|