[yt-svn] commit/yt: 2 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Wed May 4 11:09:56 PDT 2016
2 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/23470f8a59c8/
Changeset: 23470f8a59c8
Branch: yt
User: ngoldbaum
Date: 2016-05-02 20:21:04+00:00
Summary: Document that physical constants can be imported from yt.units. Closes #1082.
This deprecates importing physical constants from
yt.utilities.physical_constants in user scripts. The deprecation is only in
terms of documentation, imports in existing scripts should still work for the
forseeable future, we should just now emphasize the simpler yt.units import in
documentation.
Affected #: 6 files
diff -r 2d7b93e59428f2dc6d4cde5030cacc4b113c6ea4 -r 23470f8a59c828a72eafbc585f0b3df44f536515 doc/source/analyzing/analysis_modules/photon_simulator.rst
--- a/doc/source/analyzing/analysis_modules/photon_simulator.rst
+++ b/doc/source/analyzing/analysis_modules/photon_simulator.rst
@@ -478,7 +478,8 @@
import yt
import numpy as np
- from yt.utilities.physical_constants import cm_per_kpc, K_per_keV, mp
+ from yt.utilities.physical_ratios import cm_per_kpc, K_per_keV
+ from yt.units import mp
from yt.utilities.cosmology import Cosmology
from yt.analysis_modules.photon_simulator.api import *
import aplpy
diff -r 2d7b93e59428f2dc6d4cde5030cacc4b113c6ea4 -r 23470f8a59c828a72eafbc585f0b3df44f536515 doc/source/analyzing/units/1)_Symbolic_Units.ipynb
--- a/doc/source/analyzing/units/1)_Symbolic_Units.ipynb
+++ b/doc/source/analyzing/units/1)_Symbolic_Units.ipynb
@@ -155,7 +155,7 @@
"outputs": [],
"source": [
"from yt.units.yt_array import YTQuantity\n",
- "from yt.utilities.physical_constants import kboltz\n",
+ "from yt.units import kboltz\n",
"from numpy.random import random\n",
"import numpy as np\n",
"\n",
@@ -446,7 +446,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import G, kboltz\n",
+ "from yt.units import G, kboltz\n",
"\n",
"print (\"Newton's constant: \", G)\n",
"print (\"Newton's constant in MKS: \", G.in_mks(), \"\\n\")\n",
diff -r 2d7b93e59428f2dc6d4cde5030cacc4b113c6ea4 -r 23470f8a59c828a72eafbc585f0b3df44f536515 doc/source/analyzing/units/2)_Fields_and_unit_conversion.ipynb
--- a/doc/source/analyzing/units/2)_Fields_and_unit_conversion.ipynb
+++ b/doc/source/analyzing/units/2)_Fields_and_unit_conversion.ipynb
@@ -467,7 +467,7 @@
"metadata": {},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import kboltz\n",
+ "from yt.units import kboltz\n",
"kb = kboltz.to_astropy()"
]
},
diff -r 2d7b93e59428f2dc6d4cde5030cacc4b113c6ea4 -r 23470f8a59c828a72eafbc585f0b3df44f536515 doc/source/analyzing/units/6)_Unit_Equivalencies.ipynb
--- a/doc/source/analyzing/units/6)_Unit_Equivalencies.ipynb
+++ b/doc/source/analyzing/units/6)_Unit_Equivalencies.ipynb
@@ -41,7 +41,7 @@
"print (dd[\"temperature\"].to_equivalent(\"eV\", \"thermal\"))\n",
"\n",
"# Rest energy of the proton\n",
- "from yt.utilities.physical_constants import mp\n",
+ "from yt.units import mp\n",
"E_p = mp.to_equivalent(\"GeV\", \"mass_energy\")\n",
"print (E_p)"
]
@@ -61,7 +61,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import clight\n",
+ "from yt.units import clight\n",
"v = 0.1*clight\n",
"g = v.to_equivalent(\"dimensionless\", \"lorentz\")\n",
"print (g)\n",
@@ -166,7 +166,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import qp # the elementary charge in esu\n",
+ "from yt.units import qp # the elementary charge in esu\n",
"qp_SI = qp.to_equivalent(\"C\",\"SI\") # convert to Coulombs\n",
"print (qp)\n",
"print (qp_SI)"
diff -r 2d7b93e59428f2dc6d4cde5030cacc4b113c6ea4 -r 23470f8a59c828a72eafbc585f0b3df44f536515 doc/source/analyzing/units/7)_Unit_Systems.ipynb
--- a/doc/source/analyzing/units/7)_Unit_Systems.ipynb
+++ b/doc/source/analyzing/units/7)_Unit_Systems.ipynb
@@ -324,7 +324,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import G\n",
+ "from yt.units import G\n",
"print (G.in_base(\"mks\"))"
]
},
diff -r 2d7b93e59428f2dc6d4cde5030cacc4b113c6ea4 -r 23470f8a59c828a72eafbc585f0b3df44f536515 doc/source/developing/creating_derived_fields.rst
--- a/doc/source/developing/creating_derived_fields.rst
+++ b/doc/source/developing/creating_derived_fields.rst
@@ -71,9 +71,9 @@
a dimensionless float or array.
If your field definition includes physical constants rather than defining a
-constant as a float, you can import it from ``yt.utilities.physical_constants``
+constant as a float, you can import it from ``yt.units``
to get a predefined version of the constant with the correct units. If you know
-the units your data is supposed to have ahead of time, you can import unit
+the units your data is supposed to have ahead of time, you can also import unit
symbols like ``g`` or ``cm`` from the ``yt.units`` namespace and multiply the
return value of your field function by the appropriate combination of unit
symbols for your field's units. You can also convert floats or NumPy arrays into
https://bitbucket.org/yt_analysis/yt/commits/2f2c9e84c335/
Changeset: 2f2c9e84c335
Branch: yt
User: atmyers
Date: 2016-05-04 18:09:41+00:00
Summary: Merged in ngoldbaum/yt (pull request #2155)
Document that physical constants can be imported from yt.units. Closes #1082.
Affected #: 6 files
diff -r 02f769322a522e75ad581a23e907d4af0339a086 -r 2f2c9e84c335e5d4be9c4eac86b1f67aed7e752f doc/source/analyzing/analysis_modules/photon_simulator.rst
--- a/doc/source/analyzing/analysis_modules/photon_simulator.rst
+++ b/doc/source/analyzing/analysis_modules/photon_simulator.rst
@@ -478,7 +478,8 @@
import yt
import numpy as np
- from yt.utilities.physical_constants import cm_per_kpc, K_per_keV, mp
+ from yt.utilities.physical_ratios import cm_per_kpc, K_per_keV
+ from yt.units import mp
from yt.utilities.cosmology import Cosmology
from yt.analysis_modules.photon_simulator.api import *
import aplpy
diff -r 02f769322a522e75ad581a23e907d4af0339a086 -r 2f2c9e84c335e5d4be9c4eac86b1f67aed7e752f doc/source/analyzing/units/1)_Symbolic_Units.ipynb
--- a/doc/source/analyzing/units/1)_Symbolic_Units.ipynb
+++ b/doc/source/analyzing/units/1)_Symbolic_Units.ipynb
@@ -155,7 +155,7 @@
"outputs": [],
"source": [
"from yt.units.yt_array import YTQuantity\n",
- "from yt.utilities.physical_constants import kboltz\n",
+ "from yt.units import kboltz\n",
"from numpy.random import random\n",
"import numpy as np\n",
"\n",
@@ -446,7 +446,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import G, kboltz\n",
+ "from yt.units import G, kboltz\n",
"\n",
"print (\"Newton's constant: \", G)\n",
"print (\"Newton's constant in MKS: \", G.in_mks(), \"\\n\")\n",
diff -r 02f769322a522e75ad581a23e907d4af0339a086 -r 2f2c9e84c335e5d4be9c4eac86b1f67aed7e752f doc/source/analyzing/units/2)_Fields_and_unit_conversion.ipynb
--- a/doc/source/analyzing/units/2)_Fields_and_unit_conversion.ipynb
+++ b/doc/source/analyzing/units/2)_Fields_and_unit_conversion.ipynb
@@ -467,7 +467,7 @@
"metadata": {},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import kboltz\n",
+ "from yt.units import kboltz\n",
"kb = kboltz.to_astropy()"
]
},
diff -r 02f769322a522e75ad581a23e907d4af0339a086 -r 2f2c9e84c335e5d4be9c4eac86b1f67aed7e752f doc/source/analyzing/units/6)_Unit_Equivalencies.ipynb
--- a/doc/source/analyzing/units/6)_Unit_Equivalencies.ipynb
+++ b/doc/source/analyzing/units/6)_Unit_Equivalencies.ipynb
@@ -41,7 +41,7 @@
"print (dd[\"temperature\"].to_equivalent(\"eV\", \"thermal\"))\n",
"\n",
"# Rest energy of the proton\n",
- "from yt.utilities.physical_constants import mp\n",
+ "from yt.units import mp\n",
"E_p = mp.to_equivalent(\"GeV\", \"mass_energy\")\n",
"print (E_p)"
]
@@ -61,7 +61,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import clight\n",
+ "from yt.units import clight\n",
"v = 0.1*clight\n",
"g = v.to_equivalent(\"dimensionless\", \"lorentz\")\n",
"print (g)\n",
@@ -166,7 +166,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import qp # the elementary charge in esu\n",
+ "from yt.units import qp # the elementary charge in esu\n",
"qp_SI = qp.to_equivalent(\"C\",\"SI\") # convert to Coulombs\n",
"print (qp)\n",
"print (qp_SI)"
diff -r 02f769322a522e75ad581a23e907d4af0339a086 -r 2f2c9e84c335e5d4be9c4eac86b1f67aed7e752f doc/source/analyzing/units/7)_Unit_Systems.ipynb
--- a/doc/source/analyzing/units/7)_Unit_Systems.ipynb
+++ b/doc/source/analyzing/units/7)_Unit_Systems.ipynb
@@ -324,7 +324,7 @@
},
"outputs": [],
"source": [
- "from yt.utilities.physical_constants import G\n",
+ "from yt.units import G\n",
"print (G.in_base(\"mks\"))"
]
},
diff -r 02f769322a522e75ad581a23e907d4af0339a086 -r 2f2c9e84c335e5d4be9c4eac86b1f67aed7e752f doc/source/developing/creating_derived_fields.rst
--- a/doc/source/developing/creating_derived_fields.rst
+++ b/doc/source/developing/creating_derived_fields.rst
@@ -71,9 +71,9 @@
a dimensionless float or array.
If your field definition includes physical constants rather than defining a
-constant as a float, you can import it from ``yt.utilities.physical_constants``
+constant as a float, you can import it from ``yt.units``
to get a predefined version of the constant with the correct units. If you know
-the units your data is supposed to have ahead of time, you can import unit
+the units your data is supposed to have ahead of time, you can also import unit
symbols like ``g`` or ``cm`` from the ``yt.units`` namespace and multiply the
return value of your field function by the appropriate combination of unit
symbols for your field's units. You can also convert floats or NumPy arrays into
Repository URL: https://bitbucket.org/yt_analysis/yt/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.spacepope.org/pipermail/yt-svn-spacepope.org/attachments/20160504/d78fe722/attachment-0002.htm>
More information about the yt-svn
mailing list