Merge branch 'master' of https://github.com/rustychris/stompy

Author: Rusty Holleman

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,4 @@
+name: Publish Python distribution to PyPI and TestPyPI
+
+on: push
+

.idea/.gitignore

@@ -1,38 +1,33 @@
-# 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
+
+See the [Documentation pages](https://stompy.readthedocs.io/en/latest/) for descriptions of the various modules.
+
+## Issues
 
- 
+If you run into any bugs using `stompy`, you are encouraged to submit an [Issue](https://github.com/rustychris/stompy/issues) or PR to this repo.

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,47 @@
+# pyproject.toml
+
+[build-system]
+requires = ["setuptools>=67.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stompy-ocean"
+version = "0.0.3"
+description = "Various python modules related to modeling and oceanographic data analysis."
+readme = {file = "README.md", content-type = "text/markdown"}
+authors = [{ name = "Rusty Holleman", email = "[email protected]" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+keywords = ["modeling", "oceanography", "grid"]
+dependencies = ["cmocean",
+"matplotlib",
+"netCDF4",
+"pandas",
+"requests",
+"scipy",
+"Shapely",
+"six",
+"xarray",
+"seawater",
+"gdal<3.9",
+"numpy<2.0",
+"cgal"
+]
+requires-python = ">=3.0"
+
+[tool.setuptools]
+packages=['stompy', 'stompy.grid', 'stompy.io', 'stompy.io.local',
+              'stompy.model', 'stompy.model.delft', 'stompy.model.fvcom',
+              'stompy.model.pypart', 'stompy.model.suntans',
+              'stompy.plot', 'stompy.plot.cmaps',
+              'stompy.spatial']
+
+[tool.setuptools.package-data]
+stompy = ["tide_consts.txt"]
+
+[project.urls]
+Homepage = "https://github.com/rustychris/stompy"

.idea/inspectionProfiles/profiles_settings.xml

@@ -1,8 +1,6 @@
 cmocean
-future
 gdal
 matplotlib
-pyqt
 netCDF4
 numpy
 pandas