Page MenuHomeHEPForge
Files F8724465

No OneTemporary
Actions

View Options

diff --git a/Changes.md b/Changes-API.md
similarity index 60%
copy from Changes.md
copy to Changes-API.md
index 28babff..63632a2 100644
--- a/Changes.md
+++ b/Changes-API.md
@@ -1,55 +1,53 @@
-# Version 2.0
+# Changelog for HEJ API
-## 2.X.0
+This log lists only changes on the HEJ API. These are primarily code changes
+relevant for calling HEJ as an API. This file should only be read as an addition
+to `Changes.md`, where the main features are documented.
+
+## Version 2.X
+
+### 2.X.0
* Made `MatrixElement.tree_kin(...)` and `MatrixElement.tree_param(...)` public
-* Allow multiplication and division of multiple scale functions e.g.
- `H_T/2*m_j1j2`
-* Follow HepMC convention for particle Status codes: incoming = 11,
- decaying = 2, outgoing = 1 (unchanged)
* New class `CrossSectionAccumulator` to keep track of Cross Section of the
different subproccess
* New template struct `Parameters` similar to old `Weights`
- `Weights` are now an alias for `Parameters<double>`. Calling `Weights` did
not change
- `Weights.hh` was replaced by `Parameters.hh`. The old `Weights.hh` header
will be removed in HEJ Version 2.3.0
* Function to multiplication and division of `EventParameters.weight` by double
- This can be combined with `Parameters`, e.g.
`Parameters<EventParameters>*Weights`, see also `Events.parameters()`
- Moved `EventParameters` to `Parameters.hh` header
* Restructured `Event` class
- `Event` can now only be build from a (new) `Event::EventData` class
- Removed default constructor for `Event`
- `Event::EventData` replaces the old `UnclusteredEvent` struct.
- `UnclusteredEvent` is now deprecated, and will be removed in HEJ Version
2.3.0
- Removed `Event.unclustered()` function
- Added new member function `Events.parameters()`, to directly access
(underlying) `Parameters<EventParameters>`
-## 2.0.5
+## Version 2.0
+
+### 2.0.5
-* Fixed event classification for input not ordered in rapidity
+* no changes to API
-## 2.0.4
+### 2.0.4
* Fixed wrong path of `HEJ_INCLUDE_DIR` in `hej-config.cmake`
-* Correctly include rivet headers
-* New `EXCLUDE_package` variable in `cmake` to not interface to specific
- packages
-* Consistent search and include for side packages in `cmake`
-## 2.0.3
+### 2.0.3
-* Fixed parsing of (numerical factor) * (base scale) in configuration
-* Don't change scale names, but sanitise Rivet output file names instead
+* no changes to API
-## 2.0.2
+### 2.0.2
-* Changed scale names to `"_over_"` and `"_times_"` for proper file names (was
- `"/"` and `"*"` before)
+* no changes to API
-## 2.0.1
+### 2.0.1
-* Fixed name of fixed-order generator in error message.
+* no changes to API
diff --git a/Changes.md b/Changes.md
index 28babff..43dbf9d 100644
--- a/Changes.md
+++ b/Changes.md
@@ -1,55 +1,39 @@
-# Version 2.0
+# Changelog
-## 2.X.0
+This is the log for changes to the HEJ program. Further changes to the HEJ API
+are documented in `Changes-API.md`. If you are using HEJ as a library, please
+also read the changes there.
+
+## Version 2.X
+
+### 2.X.0
-* Made `MatrixElement.tree_kin(...)` and `MatrixElement.tree_param(...)` public
* Allow multiplication and division of multiple scale functions e.g.
`H_T/2*m_j1j2`
+* Print cross sections at end of run
* Follow HepMC convention for particle Status codes: incoming = 11,
decaying = 2, outgoing = 1 (unchanged)
-* New class `CrossSectionAccumulator` to keep track of Cross Section of the
- different subproccess
-* New template struct `Parameters` similar to old `Weights`
- - `Weights` are now an alias for `Parameters<double>`. Calling `Weights` did
- not change
- - `Weights.hh` was replaced by `Parameters.hh`. The old `Weights.hh` header
- will be removed in HEJ Version 2.3.0
-* Function to multiplication and division of `EventParameters.weight` by double
- - This can be combined with `Parameters`, e.g.
- `Parameters<EventParameters>*Weights`, see also `Events.parameters()`
- - Moved `EventParameters` to `Parameters.hh` header
-* Restructured `Event` class
- - `Event` can now only be build from a (new) `Event::EventData` class
- - Removed default constructor for `Event`
- - `Event::EventData` replaces the old `UnclusteredEvent` struct.
- - `UnclusteredEvent` is now deprecated, and will be removed in HEJ Version
- 2.3.0
- - Removed `Event.unclustered()` function
- - Added new member function `Events.parameters()`, to directly access
- (underlying) `Parameters<EventParameters>`
-
-## 2.0.5
+
+## Version 2.0
+
+### 2.0.5
* Fixed event classification for input not ordered in rapidity
-## 2.0.4
+### 2.0.4
* Fixed wrong path of `HEJ_INCLUDE_DIR` in `hej-config.cmake`
-* Correctly include rivet headers
-* New `EXCLUDE_package` variable in `cmake` to not interface to specific
- packages
-* Consistent search and include for side packages in `cmake`
-## 2.0.3
+### 2.0.3
* Fixed parsing of (numerical factor) * (base scale) in configuration
* Don't change scale names, but sanitise Rivet output file names instead
-## 2.0.2
+### 2.0.2
* Changed scale names to `"_over_"` and `"_times_"` for proper file names (was
`"/"` and `"*"` before)
-## 2.0.1
+### 2.0.1
* Fixed name of fixed-order generator in error message.

File Metadata

Mime Type
text/x-diff
Expires
Mon, Jan 20, 11:32 PM (1 d, 9 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4242882
Default Alt Text
(5 KB)

Event Timeline