Skip to content

Commit

Permalink
Added publish.yml to workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
Erik-Geo committed Aug 14, 2024
1 parent 0e24018 commit 3fa4aff
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Publish GeoST

on:
push:
tags: ['*']

permissions: read-all

jobs:
deploy:
runs-on: windows-latest

permissions:
id-token: write

steps:
- name: Check out repo
uses: actions/checkout@v4
- name: Setup Pixi
uses: prefix-dev/[email protected]
with:
environments: py312

- name: Install dependencies
run: |
pip install setuptools build
- name: Build a binary wheel and a source tarball
run: python3 -m build

- name: Store the distribution packages
uses: actions/upload-artifact@v4
with:
name: python-package-distributions
path: dist/

- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ The Geological Subsurface Toolbox (geost) package is designed to be an easy-to-u

The internal BoreholeCollection, LogCollection and CptCollection classes use [Pandas](https://pandas.pydata.org/) for storing data and header information. It utilizes a custom, lightweight validation module inspired by the [Pandera](https://pandera.readthedocs.io/en/stable/) API. For spatial functions [Geopandas](https://geopandas.org/en/stable/) is used. The package also supports reading/writing parquet and geoparquet files through Pandas and Geopandas respectively.

GeoST was formerly known as PySST. We had to change the name to avoid a name conflict on PyPi.
GeoST is a work-in-progress.

## Installation (user)
In a Python > 3.12 environment, install using pip directly from the repository (temporary solution until we publish it on PyPi):
In a Python > 3.12 environment, install the latest stable release using pip:

pip install geost

Or the latest (experimental) version of the main branch directly from GitHub using:

pip install git+https://github.com/Deltares-research/geost.git

Expand Down

0 comments on commit 3fa4aff

Please sign in to comment.