Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
nbren12 committed May 29, 2024
1 parent d47cc0f commit 89a4af0
Showing 1 changed file with 4 additions and 33 deletions.
37 changes: 4 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,26 @@
# Earth2 Grid Utilities




[![pypi](https://img.shields.io/pypi/v/earth2-grid.svg)](https://pypi.org/project/earth2-grid/)
[![python](https://img.shields.io/pypi/pyversions/earth2-grid.svg)](https://pypi.org/project/earth2-grid/)
[![Build Status](https://github.com/waynerv/earth2-grid/actions/workflows/dev.yml/badge.svg)](https://github.com/waynerv/earth2-grid/actions/workflows/dev.yml)
[![codecov](https://codecov.io/gh/waynerv/earth2-grid/branch/main/graphs/badge.svg)](https://codecov.io/github/waynerv/earth2-grid)

<img src="docs/img/image.jpg" width="800px"/>


Utilities for working geographic data defined on various grids.

Features:
- regridding
- Permissively licensed python healpix utilities

Grids currently supported:
- regular lat lon
- HealPIX

Under construction:
- exporting meshes to visualization software (e.g. VTK)
- neural network primitives for different grids:
- convolutional layers
- up/downsampling
- staggered grids


* Documentation: <https://earth-2.gitlab-master-pages.nvidia.com/earth2-grid>
* GitHub: <https://github.com/waynerv/earth2-grid>
* PyPI: <https://pypi.org/project/earth2-grid/>
* Free software: BSD-3-Clause
* GitHub: <https://github.com/NVlabs/earth2grid>

## Install


```
# Install the CUDA healpix padding library
git clone https://gitlab-master.nvidia.com/tkurth/healpixpad-pytorch
git clone ssh://[email protected]:12051/earth-2/earth2-grid.git
pip install --no-build-isolation healpixpad-pytorch earth2-grid
git clone https://github.com/NVlabs/earth2grid.git
pip install --no-build-isolation earth2-grid
```

## Example
Expand All @@ -64,12 +44,3 @@ torch.Size([49152])
>>> reshaped.shape
torch.Size([12, 64, 64])
```


## Features

* TODO

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage) project template.

0 comments on commit 89a4af0

Please sign in to comment.