Update web links in documentation

astro-informatics · Aug 5, 2015 · 850f032 · 850f032
1 parent ace1e3d
commit 850f032
Show file tree

Hide file tree

Showing 60 changed files with 8,641 additions and 17 deletions.
diff --git a/README.txt b/README.txt
@@ -16,13 +16,14 @@ DESCRIPTION
      support other pixelisations of the sphere.
 
 VERSION
-     Release 1.0, 1 July 2008
+     Release 1.1
 
 AUTHORS
-     J. D. McEwen  (mcewen@mrao.cam.ac.uk)
+     J. D. McEwen  (http://www.jasonmcewen.org)
 
 ACKNOWLEDGEMENTS
      D. J. Mortlock
+     S. M. Feeney
 
 REFERENCE
      The s2 package was written originally for the development of fast
@@ -37,24 +38,24 @@ REFERENCE
        2007 (astro-ph/0506308).
 
 DOCUMENTATION
-     See doc/index_s2.html
+     See doc/index.html
 
 REQUIREMENTS
      HEALPix (http://healpix.jpl.nasa.gov/)
      CFITSIO (http://heasarc.gsfc.nasa.gov/docs/software/fitsio/)
 
 INSTALLATION
-     See doc/index_s2.html
+     See doc/index.html
 
 DOWNLOAD
-     http://www.mrao.cam.ac.uk/~jdm57/
+     http://www.jasonmcewen.org/codes.html
 
 SUPPORT
-     Contact Jason McEwen (mcewen@mrao.cam.ac.uk)
+     Contact Jason McEwen (http://www.jasonmcewen.org)
 
 NOTE
      The package is still under development
-     Please report problems/bugs by email to: mcewen@mrao.cam.ac.uk
+     Please report problems/bugs by email to Jason McEwen
 
 LICENSE
      s2 package to provide object oriented functionality for

diff --git a/doc/conv_kernel.html b/doc/conv_kernel.html
@@ -0,0 +1,33 @@
+<HTML>
+<HEAD>
+   <TITLE> function conv_kernel (generated by f90doc) </TITLE>
+</HEAD>
+<H1> Function conv_kernel </H1>
+<PRE>function conv_kernel
+
+        ! Uses
+    use <A HREF="s2_types_mod.html">s2_types_mod</A>
+
+        ! Variables
+    real (kind=s2_dp), intent(in) :: <A HREF="conv_kernel.html#var_theta">theta</A>
+    real (kind=s2_dp), optional, intent(in), dimension (:) :: <A HREF="conv_kernel.html#var_param">param</A>
+    real (kind=s2_dp) :: <A HREF="conv_kernel.html#var_val">val</A>
+    real (kind=s2_dp) :: <A HREF="conv_kernel.html#var_sigma">sigma</A>
+
+end function conv_kernel
+</PRE>
+
+<HR><H2> Description of Variables </H2>
+<A NAME="var_theta"><H3>theta</H3></A>
+<PRE>real (kind=s2_dp), intent(in) :: theta
+</PRE>
+<A NAME="var_param"><H3>param</H3></A>
+<PRE>real (kind=s2_dp), optional, intent(in), dimension (:) :: param
+</PRE>
+<A NAME="var_val"><H3>val</H3></A>
+<PRE>real (kind=s2_dp) :: val
+</PRE>
+<A NAME="var_sigma"><H3>sigma</H3></A>
+<PRE>real (kind=s2_dp) :: sigma
+</PRE>
+</HTML>
diff --git a/doc/index_s2.html → doc/index.html b/doc/index_s2.html → doc/index.html
@@ -1,12 +1,12 @@
 <HTML>
 <HEAD>
-  <TITLE> s2 v1.0 documentation </TITLE>
+  <TITLE> s2 v1.1 documentation </TITLE>
   <LINK rel="stylesheet" href="stylesheet.css" type="text/css" />
 </HEAD>
 
 <H1 ALIGN=center> s2 package documentation </H1>
 
-<H3 ALIGN=center> <a href="http:/www.mrao.cam.ac.uk/~jdm57/">Jason McEwen </a></H3>
+<H3 ALIGN=center> <a href="http://www.jasonmcewen.org">Jason McEwen </a></H3>
 
 <P>
 The s2 library contains functionality to support functions defined on
@@ -35,7 +35,7 @@ <H3 ALIGN=center> <a href="http:/www.mrao.cam.ac.uk/~jdm57/">Jason McEwen </a></
 
 <p>
 For further details see the
-<a href="../README.txt">README.txt</a>
+<a href="http://github.com/astro-informatics/s2">README.txt</a>
 file.
 
 
@@ -326,8 +326,7 @@ <H3> Cleaning up </H3>
 <HR>
 <H2> Support  </H2>
 
-For support or to report any bugs please contact Jason McEwen 
-(<CODE>mcewen@mrao.cam.ac.uk</CODE>).
+For support or to report any bugs please contact Jason McEwen.
 
 
 
@@ -339,13 +338,13 @@ <H2> Reference  </H2>
 evolved to provide much additional functionality.  If you use the code
 to produce published works please reference the download site
 <a
-href=http://www.mrao.cam.ac.uk/~jdm57/>http://www.mrao.cam.ac.uk/~jdm57/</a>
+href="http://www.jasonmcewen.org/codes.html">http://www.jasonmcewen.org/codes.html</a>
 and our related paper:
 
 <blockquote>
 J. D. McEwen, M. P. Hobson, D. J. Mortlock, and A. N. Lasenby. 
 <a
-href="http://www.mrao.cam.ac.uk/~jdm57/publications.html#mcewen:2006:fcswt">Fast
+href="http://www.jasonmcewen.org/publications.html#mcewen:2006:fcswt">Fast
 directional continuous spherical wavelet transform algorithms</a>, IEEE Trans. Sig. Proc., 55(2):520-529,
 2007.
 </blockquote>
@@ -354,15 +353,18 @@ <H2> Reference  </H2>
 <H2> Version </H2>
 
 <P>
-<STRONG>Author:</STRONG> J. D. McEwen (<CODE>mcewen@mrao.cam.ac.uk</CODE>)
+<STRONG>Author:</STRONG> J. D. McEwen
 <P>
-<STRONG>Version:</STRONG> 1.0 - July 2008
+<STRONG>Version:</STRONG> 1.1
 
 <H3> Version History </H3>
 
 <ul>
 
+<li>Version 1.1<br>
+Various updates.
 
+<p>
 <li>Version 1.0<br>
 Initial public release.
 
@@ -397,7 +399,7 @@ <H2> License </H2>
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      GNU General Public License for more details 
-     (<a href="../LICENSE.txt">LICENSE.txt</a>).
+     (LICENSE.txt).
 
      <p>
      You should have received a copy of the GNU General Public License

diff --git a/doc/kernel.html b/doc/kernel.html
@@ -0,0 +1,36 @@
+<HTML>
+<HEAD>
+   <TITLE> function kernel (generated by f90doc) </TITLE>
+</HEAD>
+<H1> Function kernel </H1>
+<PRE>function kernel
+
+        ! Uses
+    use <A HREF="s2_types_mod.html">s2_types_mod</A>
+
+        ! Variables
+    real (kind=s2_dp), intent(in) :: <A HREF="kernel.html#var_theta">theta</A>
+    real (kind=s2_dp), optional, intent(in), dimension (:) :: <A HREF="kernel.html#var_param">param</A>
+    real (kind=s2_dp) :: <A HREF="kernel.html#var_val">val</A>
+    real (kind=s2_dp) :: <A HREF="kernel.html#var_sigma">sigma</A>
+
+end function kernel
+</PRE>
+ Gaussian convolution kernel function
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+
+<HR><H2> Description of Variables </H2>
+<A NAME="var_theta"><H3>theta</H3></A>
+<PRE>real (kind=s2_dp), intent(in) :: theta
+</PRE>
+<A NAME="var_param"><H3>param</H3></A>
+<PRE>real (kind=s2_dp), optional, intent(in), dimension (:) :: param
+</PRE>
+<A NAME="var_val"><H3>val</H3></A>
+<PRE>real (kind=s2_dp) :: val
+</PRE>
+<A NAME="var_sigma"><H3>sigma</H3></A>
+<PRE>real (kind=s2_dp) :: sigma
+</PRE>
+</HTML>
diff --git a/doc/s2_about.html b/doc/s2_about.html
@@ -0,0 +1,41 @@
+<HTML>
+<HEAD>
+   <TITLE> program s2_about (generated by f90doc) </TITLE>
+  <LINK rel="stylesheet" href="stylesheet.css" type="text/css" /> </HEAD>
+<H1> Program s2_about </H1>
+<PRE>program s2_about
+
+        ! Uses
+    use <A HREF="s2_types_mod.html">s2_types_mod</A>
+
+        ! Calls
+    call parse_options
+
+        ! Subroutines and functions
+    subroutine <A HREF="s2_about.html#subroutine_parse_options">parse_options</A> ()
+
+end program s2_about
+</PRE>
+ Display information about the S2 package.
+<P>
+ Usage: 
+   <UL>
+   <LI>  [-help]: Display usage information.
+   </UL>
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+<P>
+<STRONG>Version:</STRONG> 0.1 - November 2011
+
+<HR><H2> Description of Subroutines and Functions </H2>
+<A NAME="subroutine_parse_options"><H3>parse_options</H3></A>
+<PRE>subroutine parse_options ()
+    ! Calls: getArgument
+end subroutine parse_options
+</PRE>
+ Parse the options passed when program called.
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+<P>
+<STRONG>Version:</STRONG> 0.1 - November 2004
+</HTML>
diff --git a/doc/s2_alm2map.html b/doc/s2_alm2map.html
@@ -0,0 +1,69 @@
+<HTML>
+<HEAD>
+   <TITLE> program s2_alm2map (generated by f90doc) </TITLE>
+  <LINK rel="stylesheet" href="stylesheet.css" type="text/css" /> </HEAD>
+<H1> Program s2_alm2map </H1>
+<PRE>program s2_alm2map
+
+        ! Uses
+    use <A HREF="s2_types_mod.html">s2_types_mod</A>
+    use <A HREF="s2_sky_mod.html">s2_sky_mod</A>
+
+        ! Calls
+    call parse_options
+    call s2_sky_compute_map
+    call s2_sky_free
+    call s2_sky_write_map_file
+
+        ! Variables
+    character (len=S2_STRING_LEN) :: <A HREF="s2_alm2map.html#var_filename_map">filename_map</A>
+    character (len=S2_STRING_LEN) :: <A HREF="s2_alm2map.html#var_filename_alm">filename_alm</A>
+    type (s2_sky) :: <A HREF="s2_alm2map.html#var_sky">sky</A>
+    integer :: <A HREF="s2_alm2map.html#var_nside">nside</A> = 64
+
+        ! Subroutines and functions
+    subroutine <A HREF="s2_alm2map.html#subroutine_parse_options">parse_options</A> ()
+
+end program s2_alm2map
+</PRE>
+ Read a HEALPix alm fits file, compute map and then write the map to a 
+ HEALPix map fits file.
+<P>
+ Usage: 
+   <UL>
+   <LI>  [-help]: Display usage information.
+   <LI>  [-alm filename_alm]: Name of map HEAPix alm fits file to read.
+   <LI>  [-map filename_map]: Name of HEALPix map fits file to write.
+   <LI>  [-nside]: HEALPix nside of map to be computed.
+   </UL>
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+<P>
+<STRONG>Version:</STRONG> 0.1 - November 2005
+
+<HR><H2> Description of Variables </H2>
+<A NAME="var_filename_map"><H3>filename_map</H3></A>
+<PRE>character (len=S2_STRING_LEN) :: filename_map
+</PRE>
+<A NAME="var_filename_alm"><H3>filename_alm</H3></A>
+<PRE>character (len=S2_STRING_LEN) :: filename_alm
+</PRE>
+<A NAME="var_sky"><H3>sky</H3></A>
+<PRE>type (s2_sky) :: sky
+</PRE>
+<A NAME="var_nside"><H3>nside</H3></A>
+<PRE>integer :: nside = 64
+</PRE>
+
+<HR><H2> Description of Subroutines and Functions </H2>
+<A NAME="subroutine_parse_options"><H3>parse_options</H3></A>
+<PRE>subroutine parse_options ()
+    ! Calls: getArgument
+end subroutine parse_options
+</PRE>
+ Parse the options passed when program called.
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+<P>
+<STRONG>Version:</STRONG> 0.1 - November 2004
+</HTML>
diff --git a/doc/s2_alm2matalm.html b/doc/s2_alm2matalm.html
@@ -0,0 +1,60 @@
+<HTML>
+<HEAD>
+   <TITLE> program s2_alm2matalm (generated by f90doc) </TITLE>
+  <LINK rel="stylesheet" href="stylesheet.css" type="text/css" /> </HEAD>
+<H1> Program s2_alm2matalm </H1>
+<PRE>program s2_alm2matalm
+
+        ! Uses
+    use <A HREF="s2_types_mod.html">s2_types_mod</A>
+    use <A HREF="s2_sky_mod.html">s2_sky_mod</A>
+
+        ! Calls
+    call parse_options
+    call s2_sky_free
+    call s2_sky_write_matalm_file
+
+        ! Variables
+    character (len=S2_STRING_LEN) :: <A HREF="s2_alm2matalm.html#var_filename_inp">filename_inp</A>
+    character (len=S2_STRING_LEN) :: <A HREF="s2_alm2matalm.html#var_filename_out">filename_out</A>
+    type (s2_sky) :: <A HREF="s2_alm2matalm.html#var_sky">sky</A>
+
+        ! Subroutines and functions
+    subroutine <A HREF="s2_alm2matalm.html#subroutine_parse_options">parse_options</A> ()
+
+end program s2_alm2matalm
+</PRE>
+ Read a HEALPix alm fits file and write the read alms to a matlab alm file.
+<P>
+ Usage: 
+   <UL>
+   <LI>  [-help]: Display usage information.
+   <LI>  [-inp filename_inp]: Name of HEAPix alm fits file to read.
+   <LI>  [-out filename_out]: Name of matlab alm file to write.
+   </UL>
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+
+<HR><H2> Description of Variables </H2>
+<A NAME="var_filename_inp"><H3>filename_inp</H3></A>
+<PRE>character (len=S2_STRING_LEN) :: filename_inp
+</PRE>
+<A NAME="var_filename_out"><H3>filename_out</H3></A>
+<PRE>character (len=S2_STRING_LEN) :: filename_out
+</PRE>
+<A NAME="var_sky"><H3>sky</H3></A>
+<PRE>type (s2_sky) :: sky
+</PRE>
+
+<HR><H2> Description of Subroutines and Functions </H2>
+<A NAME="subroutine_parse_options"><H3>parse_options</H3></A>
+<PRE>subroutine parse_options ()
+    ! Calls: getArgument
+end subroutine parse_options
+</PRE>
+ Parse the options passed when program called.
+<P>
+<STRONG>Author:</STRONG> J. D. McEwen (mcewen@mrao.cam.ac.uk)
+<P>
+<STRONG>Version:</STRONG> 0.1 - November 2004
+</HTML>