HydrologicEngineeringCenter / HydrologicEngineeringCenter/Vortex

extend DataWriter for NetcdfWriter

Open
#73 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
37
Forks
7
PR merge metrics
No merged PRs in 30d

Description

moving from #69

Request dss to netcdf converter

Once idea I had to help define the NETCDF structure required to vortex to properly import to DSS is to develop an additional utility that will convert a dss file to NETCDF format. This would provide a straight forward approach to users developing their own NETCDF files. Might be outside the scope of Vortex, but I personally find the CF conventions hard to follow since many datasets only partially conform to the CF convention.

Having the ability to convert NETCDF-to-DSS and from dss-to-NETCDF will provide users more options to modify the gridded data using more robust NETCDF packages (e.g, xarray).

Response

I designed Vortex with this in mind. You'll notice that the option to specify pathname parts only become available after a file is selected. So, if you were to select something like a *.nc file for output, you may see options related to that file type. To add NetCDF write capability to Vortex a NetcdfDataWriter implementation would need to be added that extends DataWriter.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the DataWriter abstraction and reviewing how existing writer implementations are selected after a file type is chosen. Then assess the requested NetcdfDataWriter scope, including DSS-to-NetCDF conversion and the required NetCDF structure; done means NetCDF output capability is integrated consistently with the existing writer design.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.