changeset 115:daa947d96290

Brief OSX documentation, and some additional constants and unit conversions for lib/radiation2.
author Daniel Potter (laptop) <d.potter@uq.edu.au>
date Sun, 18 Mar 2012 10:47:18 +0100
parents 77a7654bfbcc
children 0d99e59aebb6
files doc/sphinx/getting-started.rst lib/radiation2/source/librad2.i lib/radiation2/source/radiation_constants.hh
diffstat 3 files changed, 19 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/sphinx/getting-started.rst	Sun Mar 18 19:16:16 2012 +1000
+++ b/doc/sphinx/getting-started.rst	Sun Mar 18 10:47:18 2012 +0100
@@ -115,6 +115,20 @@
 it may be convenient to run a full linux installation within 
 VirtualBox (https://www.virtualbox.org/), on your MS-Windows computer.
 
+Using the codes on Apple OSX
+----------------------------
+The codes can be compiled and run on OSX as this is a Unix based OS.
+The Xcode development environment (https://developer.apple.com/xcode/) 
+should be downloaded and installed to provide Apple's versions of the 
+GNU Compiler Collection, Python and the make utility, amongst other
+development tools.
+popt, readline, SWIG and Tcl/Tk can either be installed from source
+or via a package manager such as MacPorts (http://www.macports.org/) or 
+Fink (http://www.finkproject.org/).
+If possible, it is recommended to install these dependencies from source.
+The required Python packages (numpy, scipy and matplotlib) are all available
+as pre-packaged binaries for OSX on sourceforge.net, although they can also
+be installed from source if necessary.
 
 SSH access to the repository for developers
 -------------------------------------------
--- a/lib/radiation2/source/librad2.i	Sun Mar 18 19:16:16 2012 +1000
+++ b/lib/radiation2/source/librad2.i	Sun Mar 18 10:47:18 2012 +0100
@@ -95,4 +95,8 @@
 # CEA heat of formation (J/mol) to TAU heat of formation (K)
 def cea_Hf2T( h_f ):
     return h_f / RC_Na / RC_k_SI 
+    
+# convert energy in Rydberg's to energy in Kelvin
+def Ry2T( Ry ):
+    return Ry * RC_Ry * RC_h_SI * RC_c_SI / RC_k_SI
 %}
--- a/lib/radiation2/source/radiation_constants.hh	Sun Mar 18 19:16:16 2012 +1000
+++ b/lib/radiation2/source/radiation_constants.hh	Sun Mar 18 10:47:18 2012 +0100
@@ -29,6 +29,7 @@
 const double RC_H_ionise_J = 2.1787113e-18; /* Hydrogen atom ionisation potential (J)    */
 const double RC_R_u        = 8.314472;      /* J/(mol.K)                                 */
 const double RC_E0         = 1.3875117e-11; /* erg, energy potential of first Bohr orbit */
+const double RC_Ry         = 1.0973732e7;   /* Rydberg constant (1/m)                    */
 
 #endif