-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Better documentation via help(...) (#48)
* Better documentation via help(...) * Minor update
- Loading branch information
1 parent
8001f4b
commit 94314ed
Showing
5 changed files
with
28 additions
and
37 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,25 +1,4 @@ | ||
# -*- coding: utf-8 -*- | ||
# Licensed under a 3-clause BSD style license, see LICENSE. | ||
""" | ||
This module `hepunits.constants` contains 2 sorts of constants: | ||
* Physical constants. | ||
* Common and/or handy constants. | ||
All constants are computed in the HEP System of Units | ||
as defined in the `hepunits.units` package. | ||
Typical use case:: | ||
>>> from hepunits.constants import c_light | ||
>>> from hepunits.units import picosecond, micrometer | ||
>>> tau_Bs = 1.5 * picosecond # a particle lifetime, say the Bs meson's | ||
>>> ctau_Bs = c_light * tau_Bs # ctau of the particle, ~450 microns | ||
>>> print ctau_Bs # result in HEP units, so mm ;-) | ||
0.449688687 | ||
>>> print ctau_Bs / micrometer # result in micrometers | ||
449.688687 | ||
""" | ||
|
||
from .constants import * |
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
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,13 +1,5 @@ | ||
# -*- coding: utf-8 -*- | ||
# Licensed under a 3-clause BSD style license, see LICENSE. | ||
|
||
""" | ||
Subpackage for the HEP System of Units, (derived) physical units and | ||
commonly-used unit prefixes. | ||
The HEP System of Units is the set of basic units originally defined by the | ||
CLHEP project. | ||
""" | ||
|
||
from .prefixes import * | ||
from .units import * |
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
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