Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Hacktoberfest 2021] Contribute filters to the netCDF-Java Zarr project #889

Open
haileyajohnson opened this issue Oct 13, 2021 · 4 comments
Labels
hacktoberfest help wanted Extra attention is needed

Comments

@haileyajohnson
Copy link
Contributor

About

NetCDF-Java recently completed work on beta read support for Zarr data formats. Part of the Zarr project is the implementation of compressors and filters (codecs). Currently, netCDF-Java includes implementation of Shuffle, Deflate/Zlib, 32-bit Checksums, and FixedScaleOffset, but we're still missing some!

If you have developed or are interested in developing filters in Java, we would love to have you contribute!

Contributing to this issue

The list of Zarr compatible codecs is provided by NumCodecs.

If you're interested in implementing a filter for netCDF-Java, follow these instructions:

  • Checkout the maint-5.x branch (Zarr is currenly only support in 5.x)
  • Create a new class in the ucar.nc2.filter package that extends the Filter.java class
  • Implement two methods: encode(byte[] dataIn) and decode(byte[] dataIn)
  • Add a FilterProvider that returns the name of your filter
  • Create a pull requests against the maint-5.x branch

Helpful links

Thank you for considering contributing!

@haileyajohnson haileyajohnson added help wanted Extra attention is needed hacktoberfest labels Oct 13, 2021
@sumitsawant
Copy link

@haileyajohnson Can I take care of this ?

@haileyajohnson
Copy link
Contributor Author

@sumitsawant we'd appreciate any contributions on this!

@sumitsawant
Copy link

@haileyajohnson Can you please assign this to me ? I'll get started .

@haileyajohnson
Copy link
Contributor Author

@sumitsawant thank you for the enthusiasm, but I'm reluctant to assign this to one person; there could be a number of pull requests contributing to this issue, implementing different filters. But you will get Hacktoberfest credit if you submit a PR that's accepted!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy