Skip to content

Updates after initial PyPI release #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ajjackson merged 2 commits into from
Jan 21, 2026
Merged

Updates after initial PyPI release #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a4bda2
Update README: add badges, install from PyPI
ajjackson Jan 21, 2026
8462f5d
Create CHANGELOG, tweak README
ajjackson Jan 21, 2026
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
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## [Unreleased](https://github.com/pace-neutrons/resins/compare/0.1.0...HEAD)

## [0.1.0](https://github.com/pace-neutrons/resins/releases/tag/0.1.0)

Initial PyPI release. API should be considered unstable between minor
versions until 1.0.

Resolution functions from AbINS (including Pychop) are implemented and
validated. Currently broaden() method operates on "sparse" points; on
dense pre-binned data this is not computationally optimal but gives an
"exact" reference for approximate optimised schemes.
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# ResINS

[![PyPI](https://img.shields.io/pypi/v/resins)](https://pypi.org/project/resins)
[![Tests](https://github.com/pace-neutrons/resins/actions/workflows/run_tests.yml/badge.svg)](https://github.com/pace-neutrons/resins/actions/workflows/run_tests.yml)
[![License](https://img.shields.io/pypi/l/resins)](https://github.com/pace-neutrons/resins/blob/main/LICENSE)

Python library for working with resolution functions of inelastic neutron scattering (INS)
instruments. This package exists to centralise all things related to resolution of INS instruments
and make it easier to work with. It pools related code from existing projects, namely
Expand All @@ -14,7 +19,7 @@ See the [main documentation](https://pace-neutrons.github.io/resins/) for more d

## Note on API stability

While we are on 0.x.y versions, there may be breaking API changes
While resins is 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.
Expand Down Expand Up @@ -84,17 +89,17 @@ However, the model also provides methods that go lower;

## Installation

This package can be installed using pip, though it is not yet on PyPI, so it has to be installed directly from GitHub:
This package can be installed from PyPI

```
pip install git+https://github.com/pace-neutrons/resins.git
pip install resins
```

or from a local copy:

```
git clone https://github.com/pace-neutrons/resins.git
pip install resins
pip install ./resins
```


Loading