Skip to content
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

Sass/bulk observables #321

Merged
merged 10 commits into from
Dec 11, 2024
Merged

Sass/bulk observables #321

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
35ad6aa
Add BulkObservables and corresponding tests
nilssass Nov 22, 2024
9ecc29a
Adjust typing
nilssass Nov 22, 2024
7944945
Minor modifications and documentation polishing
NGoetz Dec 11, 2024
94b9766
Cleanup tests
NGoetz Dec 11, 2024
656d148
Include in documentation
NGoetz Dec 11, 2024
8a211ca
Include in Changelog
NGoetz Dec 11, 2024
d5cda2f
Fix typo
NGoetz Dec 11, 2024
49ea2bb
Merge branch 'sparkx_devel' into sass/BulkObservables
NGoetz Dec 11, 2024
d6ddca1
Auto-format code with black
github-actions[bot] Dec 11, 2024
057e3b4
Beautify documentation
NGoetz Dec 11, 2024
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ Date:
* Jetscape: Add transverse mass cut to methods
* Added ParticleObjectStorer to store generic particle lists
* SPARKX checks now for static tying consistency
* Added support for the SMASH 3.2 feature of ASCIICustom output format
* Added support for the SMASH 3.2 feature of custom output format
* Add option to add two Oscar/Jetscape/ParticleObjectStorer instances while preserving the event order
* BulkObservables: Add a class for calculating spectra and integrated yields
* Oscar: Add function to extract the impact parameters

### Changed
Expand Down
15 changes: 15 additions & 0 deletions docs/source/classes/BulkObservables/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _bulk_observables:

BulkObservables
===============

.. currentmodule:: BulkObservables
.. autoclass:: BulkObservables

.. automethod:: BulkObservables.dNdy
.. automethod:: BulkObservables.dNdpT
.. automethod:: BulkObservables.dNdEta
.. automethod:: BulkObservables.dNdmT
.. automethod:: BulkObservables.mid_rapidity_yield
.. automethod:: BulkObservables.mid_rapidity_mean_pT
.. automethod:: BulkObservables.mid_rapidity_mean_mT
1 change: 1 addition & 0 deletions docs/source/classes/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Classes
:maxdepth: 2

BaseStorer/index
BulkObservables/index
CentralityClasses/index
EventCharacteristics/index
flow/index
Expand Down
3 changes: 2 additions & 1 deletion docs/source/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,16 @@ The following classes will be useful for loading, filtering, and analyzing your
Data Loading and Filtering
~~~~~~~~~~~~~~~~~~~~~~~~~~

* `Oscar <classes/Oscar/index.html>`_: Reads various Oscar data formats and provides particle filtering methods.
* `Jetscape <classes/Jetscape/index.html>`_: Reads hadron or parton output from JETSCAPE/X-SCAPE and allows particle filtering.
* `Oscar <classes/Oscar/index.html>`_: Reads various Oscar data formats and provides particle filtering methods.

Event Analysis
~~~~~~~~~~~~~~

For more advanced analysis with individual particle objects,
SPARKX offers a range of classes for calculating centrality, flow, and more:

* `BulkObservables <classes/BulkObservables/index.html>`_: Calculates bulk observables like dN/dy and midrapdity yields.
* `CentralityClasses <classes/CentralityClasses/index.html>`_: Calculates centrality classes for a given set of events.
* `EventCharacteristics <classes/EventCharacteristics/index.html>`_: Calculates event characteristics like eccentricities and energy densities, which can be used as input for hydrodynamical simulations.

Expand Down
Loading