deeplycloudy / glmtools

GOES-R Geostationary Lightning Mapper Tools
BSD 3-Clause "New" or "Revised" License
63 stars 34 forks source link

Usage of Example Code is Missing Information #55

Open Rankicker795 opened 5 years ago

Rankicker795 commented 5 years ago

Hello. I am currently learning how to use glmtools to regrid some GLM data onto an ABI grid. In your README.MD, it points to make_GLM_grids.py in the examples directory. After copying and pasting it into my editor, it starts kicking off errors that it could not find lmatools. Installed the latest release of lmatools into my conda env and apparently this example code in not in sync with the latest release of lmatools. Getting errors that while it does see lmatools, it does not see some of its submodules such as write_cf_netcdf_latlon, get_GOESR_grid, etc.

So here are my issues with this:

  1. In your README.md or other documentation, should you provide additional packages that are required to run your example scripts?
  2. If so, it would be crucial to document which version of additional packages are needed.

Thanks.

djhoese commented 5 years ago

Hi @Rankicker795, I'm not a glmtools developer, but check out the docs index.rst page if you haven't already: https://github.com/deeplycloudy/glmtools/blob/master/docs/index.rst

I think the master branches of everything work but may not be what @deeplycloudy has in mind for glmtools going forward so he may suggest some other branches.

deeplycloudy commented 5 years ago

Hi @Rankicker795, yes, please use the ugf-newgrid branch and check out the docs that @djhoese referenced above. That is where current development is taking place. I will eventually merge ugf-newgrid into master, but it's waiting on some other developments on the NWS side.