diff --git a/README.md b/README.md index 4f2d96b..edcfb17 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # sectionate A package to sample grid-consistent sections from ocean model outputs -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/raphaeldussin/sectionate/master) +[![PyPI](https://badge.fury.io/py/sectionate.svg)](https://badge.fury.io/py/sectionate) +[![Conda Version](https://img.shields.io/conda/vn/conda-forge/sectionate)](https://anaconda.org/conda-forge/sectionate) +[![Docs](https://readthedocs.org/projects/sectionate/badge/?version=latest)](https://sectionate.readthedocs.io/en/latest/) +[![License](https://img.shields.io/github/license/MOM6-Community/sectionate)](https://github.com/MOM6-Community/sectionate) Quick Start Guide ----------------- **For users: minimal installation within an existing environment** ```bash -pip install sectionate +conda install sectionate ``` **For developers: installing dependencies from scratch using `conda`** diff --git a/ci/environment.yml b/ci/environment.yml index bf4810b..31d265d 100644 --- a/ci/environment.yml +++ b/ci/environment.yml @@ -1,6 +1,7 @@ name: test_env_sectionate channels: - conda-forge + - nodefaults dependencies: - python>=3.12 - pytest diff --git a/conda/meta.yaml b/conda/meta.yaml new file mode 100644 index 0000000..37cdadf --- /dev/null +++ b/conda/meta.yaml @@ -0,0 +1,49 @@ +{% set name = "sectionate" %} +{% set version = "0.3.3" %} +{% set python_min = "3.11" %} + +package: + name: {{ name|lower }} + version: {{ version }} + +source: + url: https://pypi.org/packages/source/s/sectionate/sectionate-{{ version }}.tar.gz + sha256: b855b091e0c5ac56ab09ec96822ad46ee2ec89bf3b6b3aecb53cbe16dbc36ecb + +build: + noarch: python + number: 0 + script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation + +requirements: + host: + - python {{ python_min }} + - pip + - hatchling + run: + - python >={{ python_min }} + - dask + - numba + - numpy + - scipy + - xarray + - xgcm >=0.9.0 + +test: + requires: + - python {{ python_min }} + - pip + imports: + - sectionate + commands: + - pip check + +about: + home: https://github.com/MOM6-community/sectionate + summary: A package to sample grid-consistent sections from ocean model outputs + license: GPL-3.0-only + license_file: LICENSE + +extra: + recipe-maintainers: + - hdrake diff --git a/docs/environment.yml b/docs/environment.yml index 778dd27..52bbea6 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -11,3 +11,7 @@ dependencies: - netcdf4 - pydap - pytest + - sphinx + - nbsphinx + - ipykernel + - pip