Package: scri
ScriPython/numba code for manipulating time-dependent functions of spin-weighted
spherical harmonics on future null infinityCiting this codeIf you use this code for academic work (I can't actually imagine any other use
for it), please cite the latest version that you used in your publication. The DOI is:DOI:10.5281/zenodo.4041972(BibTeX entry on Zenodo)Also please cite the papers for/by which it was produced:"Angular velocity of gravitational radiation from precessing binaries and the
corotating frame", Boyle,Phys. Rev. D, 87, 104006(2013)."Gravitational-wave modes from precessing black-hole binaries", Boyleet
al.,http://arxiv.org/abs/1409.4431(2014)."Transformations of asymptotic gravitational-wave data", Boyle,Phys. Rev. D, 93, 084031(2015).Bibtex entries for these articles can be foundhere.  It might
also be nice of you to provide a link directly to this source code.Quick startAssuming you have theanacondadistribution
of python (the preferred distribution for scientific applications),
installation is as simple ascondaupdate-y--all
condainstall-cconda-forgescriIf you need to installanacondafirst, it's very easy and doesn't require root permissions.  Justdownloadand follow the instructions — particularly setting yourPATH.  Also, make surePYTHONPATHandPYTHONHOMEarenotset.  Ensure that it worked by runningpython --version.  It should say something about anaconda; if not, you probably forgot to set yourPATH.  Now just run the installation command above.Then, in python, you can check to make sure installation worked withimportscriw=scri.WaveformModes()Now,wis an object to contain time and waveform data, as well as various
related pieces of information -- though it is trivial in this case, because we
haven't given it any data.  For more information, see the docstrings ofscri,scri.WaveformModes, etc.DependenciesThe dependencies should be taken care of automatically by the quick
installation instructions above.  However, if you run into problems (or if you
foolishly decide not to use anaconda to install things), it may be because you
are missing some or all of these:Standard packages (come with full anaconda installation)numpyscipymatplotlibh5pynumbaMy packages, available from anaconda.org and/or githubfftw(not actually mine,
but I maintain a copy for easy installation)spinsfast(not actually mine,
but I maintain a copy with updated python features)quaternionspherical_functionsAll these dependencies are installed automatically when you use thecondacommand described above.  Theanacondadistribution can co-exist with your
system python with no trouble -- you simply add the path to anaconda before
your system executables.  In fact, your system python probably needs to stay
crusty and old so that your system doesn't break, while you want to use a newer
version of python to actually run fancy new code like this.  This is whatanacondadoes for you.  It installs into your home directory, so it doesn't
require root access.  It can be uninstalled easily, since it exists entirely
inside its own directory.  And updates are trivial."Manual" installationThe instructions in the "Quick Start" section above should be sufficient, as
there really is no good reason not to useanaconda.  You will occasionally
hear people complain about it not working; these people have not installed it
correctly, and have other python-related environment variables that shouldn't
be there.  You don't want to be one of those people.Nonetheless, it is possible to install these packages without anaconda -- in
principle.  The main hurdle to overcome isnumba.  Maybe there are nice ways
to installnumbawithoutanaconda.  I don't know.  I don't care.  But if
you're awesome enough to do that, you're awesome enough to install all the
other dependencies without advice from me.  But in short, you can either use
thesetup.pyfiles as usual, or just usepip:pipinstallgit+git://github.com/moble/spinsfast
pipinstallgit+git://github.com/moble/quaternion
pipinstallgit+git://github.com/moble/spherical_functions
pipinstallgit+git://github.com/moble/scriAnd since you're justsoooocool, you already know that the--userflag is
missing from those commands because you're presumably using a virtual
environment, hotshot.(If you're really not that cool, and aren't usingvirtualenv, you might think
you shouldsudothose commands.  But there's no need if you just use the--userflag instead.  That installs packages into your user directory, which
is usually a better idea.)Note thatspinsfastdepends (for both building and running) onfftw.  If
you run into build problems withspinsfast, it probably can't find the
header or library forfftw.  See the documentation of my copy ofspinsfastherefor suggestions
on solving that problem.  Of course, withconda,fftwis installed in the
right place from my channel automatically.DocumentationTutorials and automatically generated API documentation are available onRead the Docs: scri.AcknowledgmentsThis code is, of course, hosted on github; because it is an open-source
project, the hosting is free, and all the wonderful features of github are
available, including free wiki space and web page hosting, pull requests, a
nice interface to the git logs, etc.Every change in this code isauomatically testedonTravis-CI.  This is a free service (for open-source
projects like this one), which integrates beautifully with github, detecting
each commit and automatically re-running the tests.  The code is downloaded and
installed fresh each time, and then tested, on both versions of python (2 and
3).  This ensures that no change I make to the code breaks either installation
or any of the features that I have written tests for.Every change to this code is also recompiled automatically, bundled into acondapackage, and made available for download fromanaconda.org.  Again, because this is an
open-source project all those nice features are free.The work of creating this code was supported in part by the Sherman Fairchild
Foundation and by NSF Grants No. PHY-1306125 and AST-1333129.