cusf-standalone-predictor/README.md

47 wiersze
3.0 KiB
Markdown

2010-06-14 12:05:11 +00:00
# CUSF Standalone Predictor - Version 2
2010-05-27 23:20:49 +00:00
2011-01-10 22:32:09 +00:00
Cambridge University Spaceflight landing predictor - a web-based tool for predicting the flight path and landing location of latex meteorological sounding balloons.
2010-05-27 23:20:49 +00:00
## Install
2010-06-14 12:07:12 +00:00
The source for the predictor itself is in `pred_src/` and instructions for building it can be found there.
2010-05-27 23:20:49 +00:00
2010-07-23 11:16:15 +00:00
The following items need to be executable (`chmod +x ./predict.py`) by the user under which the predictor runs:
2010-07-23 11:18:56 +00:00
2010-07-23 11:16:15 +00:00
* `predict.py`
* `pred_src/pred` (once compiled)
* `cron/clear-pydap-cache-cronjob.sh`
* `cron/purge-predictions-cronjob.sh`
2010-07-23 11:13:49 +00:00
The `predict/preds/` and `gfs/` directories need to have rwx access by the PHP interpreter and the `predict.py` python script. You will need to install the python dependencies listed in requirements.txt. In the case of PyDAP, the exact version is important; the easiest way is:
$ pip install -r requirements.txt
2010-05-29 17:58:06 +00:00
2011-01-10 22:32:09 +00:00
Other than that, just clone this repo to a non web-accessible folder and create symlinks to the `predict/` directory in the repo.
2010-05-28 23:12:07 +00:00
2010-06-14 12:05:11 +00:00
There are useful configuration options in `predict/includes/config.inc.php`.
2010-05-28 23:12:07 +00:00
## Information
2011-01-10 22:32:09 +00:00
The two shell scripts in the `cron/` directory should both be run daily. `clear-pydap-cache-cronjob.sh` clears the cache used by pydap so that old data does not build up. `purge-predictions-cronjob.sh` deletes scenarios and predictions not accessed or modified within the last 7 days. Re-running a prediction for a scenario will therefore reset its time to live to 7 more days.
2010-05-28 23:12:07 +00:00
The directory names are UUIDs comprised of an SHA1 hash of the launch parameters, and re-running predictions will overwrite data in the existing directory, rather than create a new one.
2010-08-03 08:02:38 +00:00
We use GFS data provided by the NOAA, accessed via NDAP and their [NOMADS](http://nomads.ncep.noaa.gov) distribution system. The [1.0x1.0 degree data](http://nomads.ncep.noaa.gov/txt_descriptions/GFS_high_resolution_doc.shtml) (26 vertical pressure levels) is used for standard predictions, and the [0.5x0.5 degree data](http://nomads.ncep.noaa.gov/txt_descriptions/GFS_half_degree_doc.shtml) (47 vertical pressure levels) is used for the high definition (HD) predictions.
2010-08-03 08:01:57 +00:00
2011-01-10 22:32:09 +00:00
## License
This work 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 any later version. This work 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.
2010-06-14 12:07:12 +00:00
## Credits & Acknowledgments
2010-05-27 23:20:49 +00:00
Credit as detailed in individual files, but notably:
2010-07-23 11:19:26 +00:00
2010-05-27 23:24:00 +00:00
* Rich Wareham - The new predictor and the hourly predictor system
2010-05-28 23:12:07 +00:00
* Fergus Noble, Ed Moore and many others
2010-05-27 23:20:49 +00:00
2010-08-11 13:53:24 +00:00
Adam Greig - [http://www.randomskk.net](http://www.randomskk.net) - [random@randomskk.net](mailto:random@randomskk.net)
2010-07-22 08:53:03 +00:00
Jon Sowman - [http://www.hexoc.com](http://www.hexoc.com) - [jon@hexoc.com](mailto:jon@hexoc.com)
2010-07-22 08:52:17 +00:00
2011-01-10 22:32:09 +00:00
Copyright Cambridge University Spaceflight 2009-2011 - All Rights Reserved