-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,28 @@ | ||
frzout | ||
====== | ||
Cooper-Frye hypersurface sampler. | ||
*Particlization model (Cooper-Frye sampler) for relativistic heavy-ion collisions* | ||
|
||
Current status | ||
-------------- | ||
The implementation is complete and working well. | ||
I'm working on other things at the moment and have not had time to write documentation; | ||
in the meantime, a variety of visual tests are posted at `qcd.phy.duke.edu/frzout/tests.html <http://qcd.phy.duke.edu/frzout/tests.html>`_. | ||
Documentation | ||
------------- | ||
`qcd.phy.duke.edu/frzout <http://qcd.phy.duke.edu/frzout>`_ | ||
|
||
If you're in the Duke group and want to use this, please ask me! | ||
Quick start | ||
----------- | ||
Install:: | ||
|
||
pip install frzout | ||
|
||
Basic usage: | ||
|
||
.. code-block:: python | ||
import frzout | ||
# create surface object from data arrays | ||
surface = frzout.Surface(x, sigma, v, pi=pi, Pi=Pi) | ||
# create hadron resonance gas object at T = 0.150 GeV | ||
hrg = frzout.HRG(.150) | ||
# sample particles | ||
parts = frzout.sample(surface, hrg) |