Skip to content

Commit

Permalink
Release v1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
PKua007 committed Dec 3, 2023
2 parents 62e4fb1 + b57b554 commit 8cf26c9
Show file tree
Hide file tree
Showing 132 changed files with 2,821 additions and 639 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/auto-tagger.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
name: Automatically create v[x] / latest tags

on:
workflow_dispatch:
release:
types: [published, edited]

Expand All @@ -10,7 +9,5 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: Actions-R-Us/actions-tagger@v2
env:
GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"
with:
publish_latest_tag: true
4 changes: 2 additions & 2 deletions .github/workflows/cmake.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: CMake

on:
push:
branches: [ "main" , "develop" ]
branches: [ "main" , "dev-minor" , "dev-patch" ]
pull_request:
branches: [ "main" , "develop" ]
branches: [ "main" , "dev-minor" , "dev-patch" ]

env:
BUILD_TYPE: Release
Expand Down
44 changes: 39 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
The functionality is contained in a binary compiled from a source code.
* [Input file format](doc/input-file.md) adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
* [Command line options](doc/operation-modes.md) do not strictly follow semantic versioning, although breaking changes
* [Input file format](docs/input-file.md) adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
* [Command line options](docs/operation-modes.md) do not strictly follow semantic versioning, although breaking changes
are not introduced unless necessary.
* The source code API will not be versioned semantically until the software is also distributed as a static-linked C++
library (later, with Python bindings as well).
Expand All @@ -14,6 +14,39 @@ library (later, with Python bindings as well).
## [Unreleased]


## [1.2.0] - 2023-12-03

### Fixed

* Corrected [RAMSNAP](docs/output-formats.md#class-ramsnap) format documentation.
* Using `--continue` on a finished run without averaging phases no longer throws `PreconditionException`
([#68](https://github.com/PKua007/rampack/issues/68)).
* Improved numerical stability of [class `optimize_cell`](docs/initial-arrangement.md#class-optimize_cell).
Before the fix, the minimal distance may have been determined incorrectly in selected cases.

### Changed

* Internal error reports now show a relative path of source location instead of an absolute one.
* Documentation directory `doc/` renamed to `docs/` (needed for GitHub to recognize
[contributing.md](docs/contributing.md)).
* *Distance* definition is now generalized to *distance vector* in [binning types](docs/observables.md#binning-types).
* [Shape functions](docs/observables.md#shape-functions) can now be multivalued.
* [Class `axis`](docs/observables.md#class-axis) shape function can now also output all three components of the axis.

### Added

* Added global/local switch for [class `bond_order`](docs/observables.md#class-bond_order).
* Added [class `s220`](docs/observables.md#class-s220) and [class `s221`](docs/observables.md#class-s221) correlation functions.
* Added [class `linear`](docs/observables.md#class-linear) binning type.
* Added [class `q_tensor`](docs/observables.md#class-q_tensor) shape function.
* Added [class `bin_averaged_function`](docs/observables.md#class-bin_averaged_function) bulk observable.
* Added `print_count` switch to [class `pair_density_correlation`](#class-pair_density_correlation), [class `pair_averaged_correlation`](#class-pair_averaged_correlation),
[class `density_histogram`](#class-density_histogram), [class `probability_evolution`](#class-probability_evolution) and
[class `bin_averaged_function`](#class-bin_averaged_function) observables.
* Added `normalization` arguments to [class `density_histogram`](#class-density_histogram).
* Added the [source code walkthrough](docs/source-code.md) document.


## [1.1.0] - 2023-06-21

### Fixed
Expand All @@ -25,7 +58,7 @@ library (later, with Python bindings as well).

* Added [v1] and [latest] tags.
* Added MinGW support.
* Added `randomize_rotation` lattice transformer.
* Added [class `randomize_rotation`](docs/initial-arrangement.md#class-randomize_rotation) lattice transformer.


## [1.0.0] - 2023-06-18
Expand All @@ -37,10 +70,11 @@ This is the initial stable release of the simulation software.

During the development stage (0.x versions) no changelog was maintained. The changes can be inferred from git history.

[Unreleased]: https://github.com/PKua007/rampack/compare/latest..develop
[Unreleased]: https://github.com/PKua007/rampack/compare/latest..dev-minor
[latest]: https://github.com/PKua007/rampack/releases/tag/latest
[v1]: https://github.com/PKua007/rampack/releases/tag/v1
[1.1.0]: https://github.com/PKua007/rampack/releases/tag/v1.0.0
[1.2.0]: https://github.com/PKua007/rampack/releases/tag/v1.2.0
[1.1.0]: https://github.com/PKua007/rampack/releases/tag/v1.1.0
[1.0.0]: https://github.com/PKua007/rampack/releases/tag/v1.0.0


Expand Down
4 changes: 3 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.10)
project(rampack VERSION 1.1.0)
project(rampack VERSION 1.2.0)

# Available options
option(RAMPACK_STATIC_LINKING "Build no-dependency static executable" OFF)
Expand All @@ -10,6 +10,8 @@ add_compile_definitions(RAMPACK_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}
RAMPACK_VERSION_MINOR=${PROJECT_VERSION_MINOR}
RAMPACK_VERSION_PATCH=${PROJECT_VERSION_PATCH})

add_compile_definitions("RAMPACK_ROOT_DIR=\"${PROJECT_SOURCE_DIR}\"")

# Check compiler support
if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 7.0)
Expand Down
Loading

0 comments on commit 8cf26c9

Please sign in to comment.