Welcome to the healpy documentation¶
healpy is a Python package to handle pixelated data on the sphere. It is based on the Hierarchical Equal Area isoLatitude Pixelization (HEALPix) scheme and bundles the HEALPix C++ library.
HEALPix was developed to efficiently process Cosmic Microwave Background data from Cosmology experiments like BOOMERANG and WMAP but it is now used in other branches of Astrophysics to store data from all-sky surveys. The target audience used to be primarily the Cosmology scientific community but currently anyone interested in handling pixelated data on the sphere is very welcome to propose new features.
healpy provides utilities to:
convert between sky coordinates and pixel indices in HEALPix nested and ring schemes
find pixels within a disk, a polygon or a strip in the sky
apply coordinate transformations between Galactic, Ecliptic and Equatorial reference frames
apply custom rotations either to vectors or full maps
read and write HEALPix maps to disk in FITS format
upgrade and downgrade the resolution of existing HEALPix maps
visualize maps in Mollweide, Gnomonic and Cartographic projections
transform maps to Spherical Harmonics space and back using multi-threaded C++ routines
compute Auto and Cross Power Spectra from maps and create map realizations from spectra
Tutorial¶
healpy tutorial¶
See the Jupyter Notebook version of this tutorial at https://github.com/healpy/healpy/blob/master/doc/healpy_tutorial.ipynb
See a executed version of the notebook with embedded plots at https://gist.github.com/zonca/9c114608e0903a3b8ea0bfe41c96f255
Choose the inline
backend of maptlotlib
to display the plots
inside the Jupyter Notebook
import matplotlib.pyplot as plt
%matplotlib inline
import numpy as np
import healpy as hp
NSIDE and ordering¶
Maps are simply numpy arrays, where each array element refers to a location in the sky as defined by the Healpix pixelization schemes (see the healpix website).
Note: Running the code below in a regular Python session will not display the maps; it’s recommended to use an IPython shell or a Jupyter notebook.
The resolution of the map is defined by the NSIDE parameter, which is generally a power of 2.
NSIDE = 32
print(
"Approximate resolution at NSIDE {} is {:.2} deg".format(
NSIDE, hp.nside2resol(NSIDE, arcmin=True) / 60
)
)
The function healpy.pixelfunc.nside2npix
gives the number of pixels
NPIX of the map:
NPIX = hp.nside2npix(NSIDE)
print(NPIX)
The same pixels in the map can be ordered in 2 ways, either RING, where they are numbered in the array in horizontal rings starting from the North pole:
m = np.arange(NPIX)
hp.mollview(m, title="Mollview image RING")
hp.graticule()
The standard coordinates are the colatitude \(\theta\), \(0\) at the North Pole, \(\pi/2\) at the equator and \(\pi\) at the South Pole and the longitude \(\phi\) between \(0\) and \(2\pi\) eastward, in a Mollview projection, \(\phi=0\) is at the center and increases eastward toward the left of the map.
We can also use vectors to represent coordinates, for example vec
is
the normalized vector that points to \(\theta=\pi/2, \phi=3/4\pi\):
vec = hp.ang2vec(np.pi / 2, np.pi * 3 / 4)
print(vec)
We can find the indices of all the pixels within \(10\) degrees of that point and then change the value of the map at those indices:
ipix_disc = hp.query_disc(nside=32, vec=vec, radius=np.radians(10))
m = np.arange(NPIX)
m[ipix_disc] = m.max()
hp.mollview(m, title="Mollview image RING")
We can retrieve colatitude and longitude of each pixel using
pix2ang
, in this case we notice that the first 4 pixels cover the
North Pole with pixel centers just ~\(1.5\) degrees South of the
Pole all at the same latitude. The fifth pixel is already part of
another ring of pixels.
theta, phi = np.degrees(hp.pix2ang(nside=32, ipix=[0, 1, 2, 3, 4]))
theta
phi
The RING ordering is necessary for the Spherical Harmonics transforms, the other option is NESTED ordering which is very efficient for map domain operations because scaling up and down maps is achieved just multiplying and rounding pixel indices. See below how pixel are ordered in the NESTED scheme, notice the structure of the 12 HEALPix base pixels (NSIDE 1):
m = np.arange(NPIX)
hp.mollview(m, nest=True, title="Mollview image NESTED")
All healpy
routines assume RING ordering, in fact as soon as you
read a map with read_map
, even if it was stored as NESTED, it is
transformed to RING. However, you can work in NESTED ordering passing
the nest=True
argument to most healpy
routines.
Reading and writing maps to file¶
For the following section, it is required to download larger maps by
executing from the terminal the bash script healpy_get_wmap_maps.sh
which should be available in your path.
This will download the higher resolution WMAP data into the current directory.
!healpy_get_wmap_maps.sh
wmap_map_I = hp.read_map("wmap_band_iqumap_r9_7yr_W_v4.fits")
By default, input maps are converted to RING ordering, if they are in
NESTED ordering. You can otherwise specify nest=True
to retrieve a
map is NESTED ordering, or nest=None
to keep the ordering unchanged.
By default, read_map
loads the first column, for reading other
columns you can specify the field
keyword.
write_map
writes a map to disk in FITS format, if the input map is a
list of 3 maps, they are written to a single file as I,Q,U polarization
components:
hp.write_map("my_map.fits", wmap_map_I, overwrite=True)
Visualization¶
As shown above, mollweide projection with mollview
is the most
common visualization tool for HEALPIX maps. It also supports coordinate
transformation, coord
does Galactic to ecliptic coordinate
transformation, norm='hist'
sets a histogram equalized color scale
and xsize
increases the size of the image. graticule
adds
meridians and parallels.
hp.mollview(
wmap_map_I,
coord=["G", "E"],
title="Histogram equalized Ecliptic",
unit="mK",
norm="hist",
min=-1,
max=1,
)
hp.graticule()
gnomview
instead provides gnomonic projection around a position
specified by rot
, for example you can plot a projection of the
galactic center, xsize
and ysize
change the dimension of the sky
patch.
hp.gnomview(wmap_map_I, rot=[0, 0.3], title="GnomView", unit="mK", format="%.2g")
mollzoom
is a powerful tool for interactive inspection of a map, it
provides a mollweide projection where you can click to set the center of
the adjacent gnomview panel. ## Masked map, partial maps
By convention, HEALPIX uses \(-1.6375 * 10^{30}\) to mark invalid or
unseen pixels. This is stored in healpy as the constant UNSEEN
.
All healpy
functions automatically deal with maps with UNSEEN
pixels, for example mollview
marks in grey those sections of a map.
There is an alternative way of dealing with UNSEEN pixel based on the
numpyMaskedArray
class, hp.ma
loads a map as a masked array,
by convention the mask is 0 where the data are masked, while numpy
defines data masked when the mask is True, so it is necessary to flip
the mask.
mask = hp.read_map("wmap_temperature_analysis_mask_r9_7yr_v4.fits").astype(np.bool)
wmap_map_I_masked = hp.ma(wmap_map_I)
wmap_map_I_masked.mask = np.logical_not(mask)
Filling a masked array fills in the UNSEEN
value and return a
standard array that can be used by mollview
. compressed()
instead removes all the masked pixels and returns a standard array that
can be used for examples by the matplotlib hist()
function:
hp.mollview(wmap_map_I_masked.filled())
plt.hist(wmap_map_I_masked.compressed(), bins=1000);
Spherical Harmonics transforms¶
healpy
provides bindings to the C++ HEALPIX library for performing
spherical harmonic transforms. hp.anafast
computes the angular power
spectrum of a map:
LMAX = 1024
cl = hp.anafast(wmap_map_I_masked.filled(), lmax=LMAX)
ell = np.arange(len(cl))
therefore we can plot a normalized CMB spectrum and write it to disk:
plt.figure(figsize=(10, 5))
plt.plot(ell, ell * (ell + 1) * cl)
plt.xlabel("$\ell$")
plt.ylabel("$\ell(\ell+1)C_{\ell}$")
plt.grid()
hp.write_cl("cl.fits", cl, overwrite=True)
Gaussian beam map smoothing is provided by hp.smoothing
:
wmap_map_I_smoothed = hp.smoothing(wmap_map_I, fwhm=np.radians(1.))
hp.mollview(wmap_map_I_smoothed, min=-1, max=1, title="Map smoothed 1 deg")
For more information see the HEALPix primer
Installation¶
Installation procedure for Healpy¶
Requirements¶
Healpy depends on the HEALPix C++ and cfitsio C libraries. Source code for both is included with Healpy and is built automatically, so you do not need to install them yourself. Only Linux and MAC OS X are supported, not Windows.
Binary installation with conda (RECOMMENDED)¶
Conda forge provides a conda
channel with a pre-compiled version of healpy
for linux 64bit and MAC OS X platforms, you can install it in Anaconda with:
conda config --add channels conda-forge
conda install healpy
Source installation with Pip¶
It is possible to build the latest healpy
with pip
pip install --user healpy
If you have installed with pip
, you can keep your installation up to date
by upgrading from time to time:
pip install --user --upgrade healpy
On Linux with newer compilers many users reported compilation errors like configure: error: cannot run C compiled programs
,
the solution is to specifiy the flags for the C and CXX compiler:
CC=gcc CXX=g++ CFLAGS=’-fPIC’ CXXFLAGS=’-fPIC’ pip install –user healpy
Compilation issues with Mac OS¶
Currently most people report they cannot install healpy on Mac OS either via pip or building from source, due to the impossibility of compiling the HEALPix based extension. The only options right now are using conda-forge or Macports.
Installation on Mac OS with MacPorts¶
If you are using a Mac and have the MacPorts package manager, it’s even easer to install Healpy with:
sudo port install py27-healpy
Binary apt-get style packages are also available in the development versions of Debian (sid) and Ubuntu (utopic).
Almost-as-quick installation from official source release¶
Healpy is also available in the Python Package Index (PyPI). You can download it with:
curl -O https://pypi.python.org/packages/source/h/healpy/healpy-1.7.4.tar.gz
and build it with:
tar -xzf healpy-1.7.4.tar.gz
pushd healpy-1.7.4
python setup.py install --user
popd
If everything goes fine, you can test it:
python
>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> import healpy as hp
>>> hp.mollview(np.arange(12))
>>> plt.show()
or run the test suite with nose:
cd healpy-1.7.4 && python setup.py test
Building against external Healpix and cfitsio¶
Healpy uses pkg-config to detect the presence of the Healpix and cfitsio libraries. pkg-config is available on most systems. If you do not have pkg-config installed, then Healpy will download and use (but not install) a Python clone called pykg-config.
If you want to provide your own external builds of Healpix and cfitsio, then download the following packages:
HEALPix autotools-style C++ package
If you are going to install the packages in a nonstandard location (say,
--prefix=/path/to/local
), then you should set the environment variable
PKG_CONFIG_PATH=/path/to/local/lib/pkgconfig
when building. No other
environment variable settings are necessary, and you do not need to set
PKG_CONFIG_PATH
to use Healpy after you have built it.
Then, unpack each of the above packages and build them with the usual
configure; make; make install
recipe.
Development install¶
Developers building from a snapshot of the github repository need:
autoconf
andlibtool
(in Debian or Ubuntu:sudo apt-get install autoconf automake libtool pkg-config
)cython > 0.16
run
git submodule init
andgit submodule update
to get the bundled HEALPix sources
the best way to install healpy if you plan to develop is to build the C++ extensions in place with:
python setup.py build_ext --inplace
then add the healpy
repository folder to your PYTHONPATH
(e.g. if you
cloned this repository to $REPOS
such that $REPOS/healpy/INSTALL.rst
exists, then add $REPOS/healpy
to your PYTHONPATH
).
In case of compilation errors, see the note above in the pip
section.
Clean¶
When you run “python setup.py”, temporary build products are placed in the
“build” directory. If you want to clean out and remove the build
directory,
then run:
python setup.py clean --all
Reference¶
sphtfunc
– Spherical harmonic transforms¶
From map to spherical harmonics¶
|
Computes the power spectrum of a Healpix map, or the cross-spectrum between two maps if map2 is given. |
|
Computes the alm of a Healpix map. |
From spherical harmonics to map¶
|
Create a map(s) from cl(s). |
|
Computes a Healpix map given the alm. |
|
Computes a Healpix map and its first derivatives given the alm. |
Spherical harmonic transform tools¶
|
Smooth a map with a Gaussian symmetric beam. |
|
Smooth alm with a Gaussian symmetric beam function. |
|
Computes (cross-)spectra from alm(s). |
|
Generate a set of alm given cl. |
|
Multiply alm by a function of l. |
|
Return the pixel window function for the given nside. |
|
This class provides some static methods for alm index computation. |
Other tools¶
|
Gaussian beam window function |
|
Computes a transfer (or window) function b(l) in spherical harmonic space from its circular beam profile b(theta) in real space. |
|
Computes a circular beam profile b(theta) in real space from its transfer (or window) function b(l) in spherical harmonic space. |
visufunc
– Visualisation¶
Map projections¶
|
Plot a healpix map (given as an array) in Mollweide projection. |
|
Plot a healpix map (given as an array) in Gnomonic projection. |
|
Plot a healpix map (given as an array) in Cartesian projection. |
|
Plot a healpix map (given as an array) in Orthographic projection. |
Graticules¶
|
Draw a graticule on the current Axes. |
Delete all graticules previously created on the Axes. |
Tracing lines or points¶
|
projplot is a wrapper around |
|
Projscatter is a wrapper around |
|
Projtext is a wrapper around |
Pixel querying routines¶
Returns pixels whose centers lie within the disk defined by vec and radius (in radians) (if inclusive is False), or which overlap with this disk (if inclusive is True). |
|
Returns the pixels whose centers lie within the convex polygon defined by the vertices array (if inclusive is False), or which overlap with this polygon (if inclusive is True). |
|
Returns pixels whose centers lie within the colatitude range defined by theta1 and theta2 (if inclusive is False), or which overlap with this region (if inclusive is True). |
|
Returns an array containing vectors to the boundary of the nominated pixel. |
rotator
– Rotation and geometry functions¶
Rotation¶
|
Rotation operator, including astronomical coordinate systems. |
|
Rotate a vector (or a list of vectors) using the rotation matrix given as first argument. |
|
Rotate the vector described by angles theta,phi using the rotation matrix given as first argument. |
projector
– Spherical projections¶
Basic classes¶
|
This class defines functions for spherical projection. |
|
This class provides class methods for Gnomonic projection. |
|
This class provides class methods for Mollweide projection. |
|
This class provides class methods for Cartesian projection. |
Indices and tables¶
License¶
Licenses¶
Healpy License¶
Healpy is licensed under the GNU General Public License.
- GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software–to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation’s software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author’s protection and ours, we want to make certain
that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors’ reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone’s free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The “Program”, below, refers to any such program or work, and a “work based on the Program” means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term “modification”.) Each licensee is addressed as “you”.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
You may copy and distribute verbatim copies of the Program’s
source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
<one line to give the program’s name and a brief idea of what it does.> Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, 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.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
The hypothetical commands `show w’ and `show c’ should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w’ and `show c’; they could even be mouse-clicks or menu items–whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision’ (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice
This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.