https://github.com/oceanmodeling/seanode
https://github.com/oceanmodeling/seanode
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oceanmodeling/seanode
- Owner: oceanmodeling
- License: cc0-1.0
- Created: 2025-03-14T21:00:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-16T17:47:00.000Z (6 months ago)
- Last Synced: 2025-12-30T07:27:05.536Z (6 months ago)
- Language: Python
- Size: 344 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Extract STOFS and related model data at station locations..
# Installation
## Standard usage
For usage in your own python software, seanode can be installed with pip:
```
pip install git+ssh://git@github.com/oceanmodeling/seanode.git
```
Or add to a `requirements.txt` file:
```
...
seanode @ git+ssh://git@github.com/oceanmodeling/seanode.git
```
which can be used to create a virtual env:
```
pip install -r requirements.txt
```
## Development
### Set up conda environment
This package has so far been developed and tested using `python 3.12`. If needed, use conda to get this:
```
# Download and set up conda:
wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
bash Miniforge3-Linux-x86_64.sh -b -p "${HOME}/conda"
source "${HOME}/conda/etc/profile.d/conda.sh"
source "${HOME}/conda/etc/profile.d/mamba.sh"
# Set up a new virtual environment:
mamba create --name=py312 python=3.12
mamba activate py312
```
### Clone repository
```
git clone https://github.com/oceanmodeling/seanode.git
# or
git clone git@github.com:oceanmodeling/seanode.git
```
### Install dependencies
```
cd seanode
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
### Cleanup
When finished, both the `venv` and (if applicable) `conda` environments need to be deactivated:
```
deactivate
# if needed:
mamba deactivate
```
# Usage
The main function to use is `get_surge_model_at_stations(...)`:
```
from seanode.api import get_surge_model_at_stations
```
Examples of usage are given in `example_points_query.ipynb` and the scripts in directory `tests`.