create package

.github/workflows/python-package-conda.yml

@@ -21,7 +21,7 @@ jobs:
       id: cache
     - name: Install dependencies
       run: |
-        $CONDA/bin/conda env update --file environment_testing.yml --name base
+        $CONDA/bin/conda env update --file environment.yml --name base
         $CONDA/bin/pip install netcdftime pytest gdown
       if: steps.cache.outputs.cache-hit != 'true'
     - name: Download test data

README.md

@@ -1 +1,33 @@
 # geodataset
+
+Extension of netCDF4.Dataset for geospatial data.
+
+# Installation
+
+Install requirements with conda:
+
+`conda env create -f environment.yml`
+
+Activate the environment:
+
+`conda activate geodataset`
+
+Install geodataset using pip:
+
+`pip install geodataset`
+
+# Usage
+
+Open netCDF file for input and access geo- metadata
+
+```python
+from geodataset.tools import open_netcdf
+
+n = open_netcdf('netcdf_file.nc')
+
+print(n.projection)
+
+print(n.get_bbox())
+
+print(n.get_lonlat_arrays())
+```

environment.yml

@@ -2,33 +2,18 @@ name: geodataset
 channels:
   - conda-forge
 dependencies:
-  - gdal
   - cartopy
-  - pykdtree
   - pip
+  - pykdtree
   - pip:
     - cmocean
     - cython
-    - ipdb
-    - ipython
-    - jupyter
     - matplotlib
     - mock
     - netcdf4
-    - nose
-    - notebook
     - numpy
-    - pandas
-    - paramiko
-    - pillow
-    - pygrib
     - pyproj
-    - pyshp
+    - pyresample
     - pyyaml
-    - rtree
-    - scikit-image
-    - scikit-learn
     - scipy
-    - shapely
     - xarray
-    - pyresample

setup.py

@@ -1,15 +1,14 @@
-import os
 import setuptools
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(
     name="geodataset",
-    version="0.0.1",
-    author="Anton Korosov",
+    version="0.1.0",
+    author=["Anton Korosov", "Timothy Williams"],
     author_email="[email protected]",
-    description="regridding tool for Geospatial data",
+    description="Extension of netDCF4.Dataset for geospatial data",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/nansencenter/geodataset",
@@ -19,15 +18,13 @@
         "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
         "Operating System :: POSIX :: Linux",
     ],
-    install_requires=["numpy",
-                      "scipy",
-                      "matplotlib",
-                      "notebook",
-                      "pyproj",
-                      "cython",
-                      "shapely",
-                      "netcdftime",
-                      "cartopy",
-                      "satpy"],
-    python_requires='>=3.7'
+    install_requires=[
+        "cartopy",
+        "netCDF4",
+        "netcdftime",
+        "numpy",
+        "pyproj",
+        "pyresample",
+        "xarray"],
+    python_requires='>=3.8'
 )