Skip to content

Commit

Permalink
Merge branch 'release/v0.11.3'
Browse files Browse the repository at this point in the history
* release/v0.11.3:
  Bump version to v0.11.3
  Update README and workflow docs
  Bump version to dev of next planned release
  • Loading branch information
brianschubert committed Jan 15, 2024
2 parents ca19768 + d5a0cb3 commit b4c5740
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 6 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Build, and test a set of distribution files.

name: Build

on: [ workflow_call, workflow_dispatch ]
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Build, test, and publish built distributions to {Test,}PyPI on tag push.

name: Release

run-name: Release from ${{ github.ref }}
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Run test suite.

name: Tests

run-name: Test ${{ github.event.ref}}${{ github.event_name == 'push' && ' - ${{ github.event.head_commit.message }}' || '' }}
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/web_artifact.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Download files from the web and upload them as workflow artifacts.
#
# Intended to save time and bandwidth from having to download the same file multiple times in a single workflow run.

name: Web artifacts

on:
Expand Down
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,31 @@

This distribution provides access to compiled binaries of the [6S Radiative Transfer Model](https://salsa.umd.edu/6spage.html) as [package resources](https://docs.python.org/3/library/importlib.resources.html#module-importlib.resources).



It *does not* provide a Python interface to 6S. For a Python interface, see Robin Wilson's [Py6S].

Currently, this project includes binaries for 6SV1.1 and 6SV2.1. It supports Linux, macOS, and Windows.
Currently, this project includes binaries for 6SV1.1 and 6SV2.1. It requires Python 3.9+ and supports Linux, macOS, and Windows.

## Install

Pre-compiled development wheels can be installed from [TestPyPI](https://test.pypi.org/project/6s-bin/):
Pre-compiled wheels can be installed from [PyPI](https://pypi.org/project/6s-bin/):
```shell
$ pip install 6s-bin
```
If you are using [poetry](https://python-poetry.org/), you can add this distribution as a dependency using
`poetry add`:
```shell
$ pip install -i https://test.pypi.org/simple/ 6s-bin
$ poetry add 6s-bin
```

### Installing from source

Building this distribution involves downloading, validating, and compiling the 6S source code. See [`build.py`](./build.py) for details about the build process. A Fortran 77 compiler is required to compile 6S.

Build and install from source distribution:
```shell
$ pip install --no-binary=6s-bin 6s-bin
```

Build and install from git:
```shell
$ pip install '6s-bin @ git+https://github.com/brianschubert/6s-bin'
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "6s-bin"
version = "0.11.2"
version = "0.11.3"
description = "Compiled binaries for the 6S Radiative Transfer Model exposed as package resources."
license = "Apache-2.0"
authors = ["Brian Schubert <[email protected]>"]
Expand Down

0 comments on commit b4c5740

Please sign in to comment.