zfp

Compressed numerical arrays that support high-speed random access

https://github.com/llnl/zfp

Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README
  • Academic publication links
    Links to: researchgate.net
  • Committers with academic emails
    9 of 32 committers (28.1%) from academic institutions
  • Institutional organization owner
    Organization llnl has institutional domain (software.llnl.gov)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.9%) to scientific vocabulary

Keywords

arrays compression data-viz floating-point radiuss

Keywords from Contributors

closember gtk qt tk wx mesh parallel sequences interactive hacking
Last synced: 6 months ago · JSON representation ·

Repository

Compressed numerical arrays that support high-speed random access

Basic Info
  • Host: GitHub
  • Owner: LLNL
  • License: bsd-3-clause
  • Language: C++
  • Default Branch: develop
  • Homepage: http://zfp.llnl.gov
  • Size: 4.1 MB
Statistics
  • Stars: 811
  • Watchers: 27
  • Forks: 167
  • Open Issues: 42
  • Releases: 6
Topics
arrays compression data-viz floating-point radiuss
Created almost 10 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Citation Support

README.md

ZFP

GitHub Actions Test Status Appveyor Build Status Documentation Status codecov R&D100 - Winner

zfp is a compressed format for representing multidimensional floating-point and integer arrays. zfp provides compressed-array classes that support high throughput read and write random access to individual array elements. zfp also supports serial and parallel (OpenMP and CUDA) compression of whole arrays, e.g., for applications that read and write large data sets to and from disk.

zfp uses lossy but optionally error-bounded compression to achieve high compression ratios. Bit-for-bit lossless compression is also possible through one of zfp's compression modes. zfp works best for 2D, 3D, and 4D arrays that exhibit spatial correlation, such as continuous fields from physics simulations, natural images, regularly sampled terrain surfaces, etc. zfp compression of 1D arrays is possible but generally discouraged.

zfp is freely available as open source and is distributed under a BSD license. zfp is primarily written in C and C++ but also includes Python and Fortran bindings. zfp conforms to various language standards, including C89, C99, C11, C++98, C++11, and C++14, and is supported on Linux, macOS, and Windows.

Quick Start

To download zfp, type:

git clone https://github.com/LLNL/zfp.git

zfp may be built using either CMake or GNU make. To use CMake, type:

cd zfp
mkdir build
cd build
cmake ..
cmake --build . --config Release
ctest

This builds the zfp library in the build/lib directory and the zfp command-line executable in the build/bin directory. It then runs the regression tests. The full test suite may be run by enabling the BUILD_TESTING_FULL CMake option during the build step.

zfp may also be built using GNU make:

cd zfp
make
make test

Note: GNU builds are less flexible and do not support all available features, e.g., CUDA support.

For further configuration and build instructions, please consult the documentation. For examples of how to call the C library and use the C++ array classes, see the examples section.

Documentation

Full HTML documentation is available online. A PDF version is also available.

Further information on the zfp software is included in these files:

Authors

zfp was originally developed by Peter Lindstrom at Lawrence Livermore National Laboratory. Please see the Contributors Page for a full list of contributors.

Citing zfp

If you use zfp for scholarly research, please cite this paper:

The algorithm implemented in the current version of zfp is described in the documentation and in the following paper:

License

zfp is distributed under the terms of the BSD 3-Clause license. See LICENSE and NOTICE for details.

SPDX-License-Identifier: BSD-3-Clause

LLNL-CODE-663824

Owner

  • Name: Lawrence Livermore National Laboratory
  • Login: LLNL
  • Kind: organization
  • Email: github-admin@llnl.gov
  • Location: Livermore, CA, USA

For over 70 years, the Lawrence Livermore National Laboratory has applied science and technology to make the world a safer place.

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Lindstrom
    given-names: Peter
    orcid: https://orcid.org/0000-0003-3817-4199
title: "Fixed-Rate Compressed Floating-Point Arrays"
journal: "IEEE Transactions on Visualization and Computer Graphics"
volume: 20
number: 12
start: 2674
end: 2683
year: 2014
month: 12
version: develop
doi: 10.1109/TVCG.2014.2346458
date-released: 2014-11-05

GitHub Events

Total
  • Create event: 1
  • Issues event: 15
  • Watch event: 61
  • Delete event: 2
  • Member event: 2
  • Issue comment event: 114
  • Push event: 32
  • Pull request review comment event: 14
  • Pull request review event: 22
  • Pull request event: 46
  • Fork event: 11
Last Year
  • Create event: 1
  • Issues event: 15
  • Watch event: 61
  • Delete event: 2
  • Member event: 2
  • Issue comment event: 114
  • Push event: 32
  • Pull request review comment event: 14
  • Pull request review event: 22
  • Pull request event: 46
  • Fork event: 11

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 1,039
  • Total Committers: 32
  • Avg Commits per committer: 32.469
  • Development Distribution Score (DDS): 0.533
Past Year
  • Commits: 29
  • Committers: 4
  • Avg Commits per committer: 7.25
  • Development Distribution Score (DDS): 0.172
Top Committers
Name Email Commits
lindstro pl@l****v 485
Markus Salasoo s****1@l****v 253
Garrett Morrison m****2@l****v 141
Stephen Herbein s****2@g****m 41
mclarsen l****0@l****v 21
halehawk h****x@u****u 19
Chuck Atkins c****s@k****m 13
William Silversmith w****h@g****m 8
Wojciech Mamrak w****k@g****m 6
David Wade d****d@e****m 6
Dimitri Papadopoulos 3****s 5
Ian Lee l****1@l****v 5
dependabot[bot] 4****] 4
maddyscientist m****k@n****m 4
Mohamed A. Bamakhrama m****d 4
miller86 m****6@l****v 3
Robert Maynard r****d@k****m 3
Benjamin Curtice Corbett c****5@l****v 2
Mark Harfouche m****e@g****m 2
Vicente Adolfo Bolea Sanchez v****a@k****m 2
Anthony Lichnewsky a****y@s****m 1
Pedro Melgueira p****a@p****m 1
Mohamed A. Bamakhrama m****a@a****m 1
Lennart Noordsij - LNOQ l****j@a****m 1
Ben Boeckel b****l@k****m 1
Christoph Gohlke c****e@g****m 1
Jan-Willem Blokland J****d@S****m 1
Jonas Haag j****s@l****g 1
LennartNoordsij L****j@g****m 1
Ryan Mast m****9@l****v 1
and 2 more...
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 97
  • Total pull requests: 95
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 66
  • Total pull request authors: 31
  • Average comments per issue: 5.21
  • Average comments per pull request: 2.95
  • Merged pull requests: 60
  • Bot issues: 0
  • Bot pull requests: 7
Past Year
  • Issues: 10
  • Pull requests: 39
  • Average time to close issues: 4 days
  • Average time to close pull requests: 5 days
  • Issue authors: 8
  • Pull request authors: 9
  • Average comments per issue: 0.5
  • Average comments per pull request: 1.87
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • lindstro (14)
  • data-panda (3)
  • qingyiyi (3)
  • jwsblokland (3)
  • juntyr (2)
  • pkoosha (2)
  • bojeckkk (2)
  • markcmiller86 (2)
  • william-silversmith (2)
  • tpwrules (2)
  • aavbsouza (2)
  • Chuan1937 (2)
  • yurivict (2)
  • shauryapatel1995 (2)
  • qwj118 (2)
Pull Request Authors
  • vicentebolea (28)
  • william-silversmith (8)
  • dependabot[bot] (7)
  • gthomascollignon (6)
  • JieyangChen7 (5)
  • DimitriPapadopoulos (5)
  • robertu94 (4)
  • frobnitzem (2)
  • GarrettDMorrison (2)
  • jaimergp (2)
  • svdree-shell (2)
  • nightlark (2)
  • corbett5 (2)
  • mirounga (2)
  • Staudey (2)
Top Labels
Issue Labels
bug (10) enhancement (5) help wanted (3) question (1) documentation (1) performance (1)
Pull Request Labels
dependencies (7) github_actions (1)

Packages

  • Total packages: 4
  • Total downloads: unknown
  • Total dependent packages: 13
    (may contain duplicates)
  • Total dependent repositories: 230
    (may contain duplicates)
  • Total versions: 8
conda-forge.org: zfp

zfp is an open source C/C++ library for compressed numerical arrays that support high throughput read and write random access. zfp also supports streaming compression of integer and floating-point data, e.g., for applications that read and write large data sets to and from disk. zfp is primarily written in C and C++ but also includes Python and Fortran bindings.

  • Homepage: https://zfp.llnl.gov
  • License: BSD-3-Clause
  • Latest release: 1.0.0
    published over 3 years ago
  • Versions: 2
  • Dependent Packages: 9
  • Dependent Repositories: 111
Rankings
Dependent repos count: 3.2%
Dependent packages count: 6.5%
Average: 10.4%
Forks count: 15.9%
Stargazers count: 16.2%
Last synced: 7 months ago
conda-forge.org: zfpy

zfp is an open source C/C++ library for compressed numerical arrays that support high throughput read and write random access. zfp also supports streaming compression of integer and floating-point data, e.g., for applications that read and write large data sets to and from disk. zfp is primarily written in C and C++ but also includes Python and Fortran bindings.

  • Homepage: https://zfp.llnl.gov
  • License: BSD-3-Clause
  • Latest release: 1.0.0
    published over 3 years ago
  • Versions: 2
  • Dependent Packages: 1
  • Dependent Repositories: 4
Rankings
Forks count: 15.9%
Dependent repos count: 16.2%
Stargazers count: 16.2%
Average: 19.3%
Dependent packages count: 29.0%
Last synced: 7 months ago
anaconda.org: zfp

zfp is an open source C/C++ library for compressed numerical arrays that support high throughput read and write random access. zfp also supports streaming compression of integer and floating-point data, e.g., for applications that read and write large data sets to and from disk. zfp is primarily written in C and C++ but also includes Python and Fortran bindings.

  • Versions: 2
  • Dependent Packages: 3
  • Dependent Repositories: 111
Rankings
Dependent packages count: 15.1%
Dependent repos count: 17.9%
Average: 22.4%
Forks count: 27.8%
Stargazers count: 28.8%
Last synced: 6 months ago
anaconda.org: zfpy

zfp is an open source C/C++ library for compressed numerical arrays that support high throughput read and write random access. zfp also supports streaming compression of integer and floating-point data, e.g., for applications that read and write large data sets to and from disk. zfp is primarily written in C and C++ but also includes Python and Fortran bindings.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 4
Rankings
Forks count: 27.8%
Stargazers count: 28.8%
Average: 38.1%
Dependent repos count: 44.7%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

.github/workflows/coverage.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/debug-linux.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/debug-macos.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
docs/source/requirements.txt pypi
  • sphinx ==1.6.7
  • sphinx-fortran *
python/requirements.txt pypi
  • cython >=0.22
  • numpy >=1.8.0