Skip to content
drphilmarshall edited this page Apr 12, 2012 · 8 revisions

Accessing the Pangloss Code

We are developing open source software to infer the gravitational lensing effects of mass along the line of sight to interesting objects in the Universe. The code is scientific, we are developing it in order to answer research questions, as described on the wiki. These projects are led by graduate students, whose careers depend on publishing their results: we will not accept pull requests until their investigations are complete, and ask that their space be respected while development proceeds. The software is in currently in a 'pre-alpha' state, but is nevertheless freely available: however, we do ask that you follow the guidelines on this page before you download it.

Download

There are two ways to download the code, one for close collaborators and one for the rest of the world.

  • Close collaborators: Send email to Phil asking to become a collaborator, with read+write access.

  • Everyone else: Send email to [email protected] to introduce yourself, and then fork the git repository into an independent branch that you own.

In either case you will need to git clone the repository onto your local machine (it's worth setting up github with your ssh keys at this point). You will then be able to edit the code on your local machine. You will also be able to request to submit your changes back to the central archive. Close collaborators will be able to push directly (making collaboration fast). The github help is very well written, and does not take long to work through.

After publication, we will be able to consider pull requests submitted by anyone for consideration. For these to be considered, we'd like you to introduce yourselves! While the code is freely available to download at any time, we'd like to know if you are using it - especially if you plan on making useful modifications to it.

License

We distribute the Pangloss code under the GNU general public license (see the LICENSE file in the code repository), with the following additional recommendation that if you are working with the code, that you keep in touch. Note that providing a license is not the same as providing a warranty: while trying our best, we can't guarantee successful code.

Dependencies

It's true, you will have to have some other packages installed to run Pangloss. Here they are, they're all free, and mostly available by pip (python package manager) and homebrew:

python numpy, scipy, pyfits atpy