Moved project files to trunk for SVN compatibility.

Author: jaffar.rumith@gmail.com

LICENSE

@@ -0,0 +1,51 @@
+** About **
+This program contains two Python modules: igrf and cxform.
+
+Module igrf provides several useful methods based on IGRF v.10.
+The wrapper has been written by David Parunakian, Skobeltsyn Institute of Nuclear Physics of the Moscow State University.
+Feel free to contact me with improvement suggestions, questions etc at either rumith@srd.sinp.msu.ru or dp@xientific.info.
+The model itself is the result of hard work of many people from different institutions, such as IAGA and NASA.
+The source code and coefficient files used can be found at ftp://nssdcftp.gsfc.nasa.gov/models/geomagnetic/igrf/fortran_code/
+More information on IGRF can be found here: http://www.ngdc.noaa.gov/IAGA/vmod/igrf.html
+
+Module cxform provides access to one function - transform(), which can be used for transforming cartesian coordinates
+from one coordinate system to another. Complete documentation on cxform, as well as the list of coordinate systems supported,
+can be found at CXFORM official website http://nssdcftp.gsfc.nasa.gov/selected_software/coordinate_transform/
+
+
+** Installation **
+tar -xzf igrf.tar.gz
+cd igrf
+./install.sh
+
+The above procedure will install coefficient files to /usr/local/lib/igrf. If you wish to install them to another directory (e.g. /var/foobar), run
+./install.sh /var/foobar
+instead. PLEASE ONLY SPECIFY ABSOLUTE PATHS.
+
+** Usage **
+To use igrf in your software after you have installed it, include the following line in your code:
+
+import igrf
+
+After that, you can use the following functions:
+
+igrf.dimo(year): 
+	Find the geomagnetic dipole moment in Gauss (normalized to the Earth's radius) at the specified time (decimal year)
+
+igrf.lb(lat, lon, alt, year):
+	Find the L-shell and geomagnetic field intensity (l, b tuple) at the specified latitude, longitude, altitude and decimal year
+
+igrf.b(lat, lon, alt, year):
+	Find the Earth's magnetic field value (Bnorth, Beast, Bdown, Babs tuple) using the spherical harmonics model
+
+igrf.b0(lat, lon, alt, year, stps):
+	Find the smallest magnetic field strength on a field line. Stps is step size for field line tracing
+
+Latitude and longitude should be specified in the geographic coordinate system.
+Altitude should be specified in kilometers above sea level.
+Decimal year is a float and looks like 2003.45.
+
+
+** Legal **
+This project is distributed under the terms of the GNU General Public License v.3. The full text of the license is available
+in the LICENSE file.

README

@@ -0,0 +1,28 @@
+#include <python2.5/Python.h>
+#include "cxform.h"
+
+static PyObject *cxform_transform(PyObject *self, PyObject *args) {
+	const char *from, *to;
+	int year = 0, month = 0, day = 0, hour = 0, minute = 0, second = 0;
+	Vec v_in = {0.0, 0.0, 0.0};
+	Vec v_out = {0.0, 0.0, 0.0};
+	PyObject dt;
+
+//	if (!PyArg_ParseTuple(args, "ssdddO!", &from, &to, &v_in[0], &v_in[1], &v_in[2], "DateTime", &dt))
+//		return NULL;
+	if (!PyArg_ParseTuple(args, "ssdddiiiiii", &from, &to, &v_in[0], &v_in[1], &v_in[2], &year, &month, &day, &hour, &minute, &second))
+		return NULL;
+
+	double es = date2es(year, month, day, hour, minute, second);
+	cxform(from, to, es, v_in, v_out);
+	return Py_BuildValue("ddd", v_out[0], v_out[1], v_out[2]);
+}
+
+static PyMethodDef CxformMethods[] = {
+	{"transform",  cxform_transform, METH_VARARGS, "transform(from, to, x, y, z, year, month, day, hour, minute, second)\n\nTransform coordinates from one system to another."},
+	{NULL, NULL, 0, NULL}
+};
+
+PyMODINIT_FUNC initcxform(void) {
+	(void) Py_InitModule("cxform", CxformMethods);
+}

cxformmodule.c

@@ -0,0 +1,75 @@
+#include <python2.5/Python.h>
+#include "f2c.h"
+
+int MAIN__() { return 0; }
+
+static PyObject *igrf_dimo(PyObject *self, PyObject *args) {
+	real year, dimo;
+	if (!PyArg_ParseTuple(args, "f", &year)) {
+		return NULL;
+	}
+	feldcof_(&year, &dimo);
+	return Py_BuildValue("f", dimo);
+}
+
+static PyObject *igrf_lb(PyObject *self, PyObject *args) {
+	real glat, glon, alt, dimo, fl, b0, year;
+	integer icode;
+	if (!PyArg_ParseTuple(args, "ffff", &glat, &glon, &alt, &year)) {
+		return NULL;
+	}
+	feldcof_(&year, &dimo);
+	shellg_(&glat, &glon, &alt, &dimo, &fl, &icode, &b0);
+	return Py_BuildValue("iff", icode, fl, b0);
+}
+
+static PyObject *igrf_b(PyObject *self, PyObject *args) {
+	real glat, glon, alt, dimo, bnorth, beast, bdown, babs, year;
+	if (!PyArg_ParseTuple(args, "ffff", &glat, &glon, &alt, &year)) {
+		return NULL;
+	}
+	feldcof_(&year, &dimo);
+	feldg_(&glat, &glon, &alt, &bnorth, &beast, &bdown, &babs);
+	return Py_BuildValue("ffff", bnorth, beast, bdown, babs);
+}
+
+static PyObject *igrf_b0(PyObject *self, PyObject *args) {
+	real glat, glon, alt, dimo, fl, b0, year, stps, bdel, bequ, rr0;
+	integer icode;
+	logical value;
+	if (!PyArg_ParseTuple(args, "fffff", &glat, &glon, &alt, &year, &stps)) {
+		return NULL;
+	}
+	feldcof_(&year, &dimo);
+	shellg_(&glat, &glon, &alt, &dimo, &fl, &icode, &b0);
+	findb0_(&stps, &bdel, &value, &bequ, &rr0);
+	return Py_BuildValue("lfff", value, bequ, rr0, bdel);
+}
+
+char *trimwhitespace(char *str) {
+	char *end;
+	// Trim leading space
+	while(isspace(*str)) str++;
+	
+	// Trim trailing space
+	end = str + strlen(str) - 1;
+	while(end > str && isspace(*end)) end--;
+	
+	// Write new null terminator
+	*(end+1) = 0;
+
+	return str;
+}
+
+static PyMethodDef IgrfMethods[] = {
+	{ "dimo",  igrf_dimo, METH_VARARGS, "dimo(year)\n\nFind the geomagnetic dipole moment in Gauss (normalized to the Earth's radius) at the specified time (decimal year)" },
+	{ "lb",  igrf_lb, METH_VARARGS, "igrf.lb(lat, lon, alt, year)\n\nFind the L-shell and geomagnetic field intensity at the specified latitude, longitude, altitude and decimal year" },
+	{ "b",  igrf_b, METH_VARARGS, "igrf.b(lat, lon, alt, year)\n\nFind the Earth's magnetic field value using the spherical harmonics model" },
+	{ "b0",  igrf_b0, METH_VARARGS, "igrf.b0(lat, lon, alt, year, stps)\n\nFind the smallest magnetic field strength on a field line" },
+	{ NULL, NULL, 0, NULL }
+};
+
+PyMODINIT_FUNC initigrf(void) {
+	(void) Py_InitModule("igrf", IgrfMethods);
+	initize_();
+}

igrfmodule.c

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+if test -z "$1"
+then
+	TARGET=/usr/local/lib/pygrf/
+else
+	TARGET=$1
+fi
+
+if [ ! -d "$TARGET" ]
+then
+	sudo mkdir $TARGET
+fi
+
+if ( ! type -P f2c > /dev/null )
+then
+    echo "F2C not installed, aborting"
+		exit
+fi
+
+wget -r ftp://nssdcftp.gsfc.nasa.gov/models/geomagnetic/igrf/fortran_code/
+if [ ! -d nssdcftp.gsfc.nasa.gov]
+then
+	echo "Failed to download IGRF source code. Please check your Internet connection."
+else
+	mv nssdcftp.gsfc.nasa.gov/models/geomagnetic/igrf/fortran_code/* .
+	rm -rf nssdcftp.gsfc.nasa.gov
+	for x in `ls *.for`; do mv $x `echo $x | sed s/.for/.F/`; done
+	f2c igrf_sub.F
+
+	cat igrf_sub.c | sed "s^o__1.ofnm = fout^extern char *trimwhitespace(char *str); char prefix_dp[28] = \"$TARGET\"; 	strcat(prefix_dp, fspec); o__1.ofnm = trimwhitespace(prefix_dp)^" > igrf_sub2.c
+	mv igrf_sub2.c igrf_sub.c
+
+
+	sudo mv *.dat $TARGET
+	sudo python setup-igrf.py install
+	sudo rm -rf build *.F bilcal.log igrf_sub.c
+fi
+
+
+wget http://nssdcftp.gsfc.nasa.gov/selected_software/coordinate_transform/archive/cxform-0.71_source.tar.gz
+if [ ! -f cxform-0.71_source.tar.gz ]
+then
+	echo "Failed to download CXFORM source code. Please check your Internet connection."
+else
+	tar -xzf cxform-0.71_source.tar.gz
+	mv cxform-0.71/cxform-manual.c cxform-0.71/cxform-auto.c cxform-0.71/cxform.h .
+	sudo python setup-cxform.py install
+	sudo rm -rf build cxform-0.71/ cxform-auto.c cxform-manual.c cxform-0.71_source.tar.gz cxform.h
+fi

install.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/python
+from distutils.core import setup, Extension
+
+cxform = Extension('cxform', sources = ['cxformmodule.c', 'cxform-manual.c', 'cxform-auto.c'])
+
+setup (name = 'cxform',
+	version = '1.0',
+	description = 'NASA CXFORM 0.71 wrapper',
+	author = 'David Parunakian',
+	author_email = 'dp@xientific.info',
+	ext_modules = [cxform])

setup-cxform.py

@@ -0,0 +1,11 @@
+#!/usr/bin/python
+from distutils.core import setup, Extension
+
+igrf = Extension('igrf', sources = ['igrf_sub.c', 'igrfmodule.c'], libraries = ['m', 'f2c'], library_dirs = ['/usr/lib/'])
+
+setup(name = 'igrf',
+	version = '1.0',
+	description = 'IGRF v.10 Python wrapper',
+	author = 'David Parunakian',
+	author_email = 'dp@xientific.info',
+	ext_modules = [igrf])