Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
on: workflow_dispatch

jobs:
pypi-publish:
name: Upload release to PyPI
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/resins
permissions:
id-token: write
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0

- uses: actions/setup-python@v6
with:
python-version: 3.12

- name: build wheel, sdist
shell: bash -l {0}
run: |
python -m pip install --upgrade pip
python -m pip install build
python -m build

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ authors:
title: "ResINS"
repository-code: https://github.com/pace-neutrons/resins
license: GPL-3.0
version: 0.0.1
version: 0.1.0
keywords:
- "Python"
- "physics"
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ literature. The main purposes are:

See the [main documentation](https://pace-neutrons.github.io/resins/) for more detail.

## Note on API stability

While we are on 0.x.y versions, there may be breaking API changes
between minor (x) versions, while bugfix (y) versions may
contain fixes, trivial enhancements and development/deployment/documentation tweaks.
If you are using ResINS it is highly recommended to pin to a specific minor version e.g.

```
dependencies = [ "resins>=0.1.1,<0.2"]
```

With version 1.0 the project will move to stable semantic versioning,
and downstream projects will be able to pin to the major version.

## Quick Start

The ``resins`` library can be installed with pip (see Installation). To start, import the main `Instrument`
Expand Down
Loading