Update README.md

README.md

@@ -1,38 +1,30 @@
-# stompy
+# stompy: spatial tools for ocean modeling in python
 
 Various python modules related to modeling and oceanographic data analysis.
 
-## Installation
+## Prerequisites
 
-There is not yet a pip or conda installer setup. (if you use this code and would find that useful, please
-add an issue on github so I know somebody cares).
+ `stompy` requires a Python 3 environment with `gdal` installed. There are many ways to set this up. The recommended method would be creating a `mamba` (or `conda`) environment:
 
-### Requirements
+ ```
+mamba create -n <env-name> python gdal
+mamba activate <env-name>
+```
 
-`stompy` makes extensive use of the core packages of a modern scientific python installation,
-plus a few slightly more specialized modules:
+## Installation
 
- * python 2.7 or 3
- * six
- * numpy
- * scipy
- * gdal
- * shapely
- * matplotlib
- * xarray
- * pandas
- * netCDF
-
-### Installation
 
-Python must be able to find the `stompy` subdirectory of the repository.  So on Linux, this might look like:
+### Installing with `pip`
 
 ```
-   cd $HOME/src
-   git clone https://github.com/rustychris/stompy.git
-   export PYTHONPATH=$PYTHONPATH:$HOME/src/stompy
+pip install stompy-ocean
 ```
 
-At this point, you should be able to start python and successfully run `import stompy.grid.unstructured_grid`, for example.
+### Installing with `mamba`/`conda`
+
+Coming soon
+
+## Documentation
+
+Coming soon
 
-