From 21239cd735cde7c9f9986eaf6675b735c8ec5960 Mon Sep 17 00:00:00 2001 From: jonsowman Date: Mon, 10 Jan 2011 22:32:09 +0000 Subject: [PATCH] updated readme information --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2f55f02..e42d866 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # CUSF Standalone Predictor - Version 2 -Working on improving the Cambridge University Spaceflight landing predictor, a web-based tool for predicting the flight path and landing location of latex balloons. +Cambridge University Spaceflight landing predictor - a web-based tool for predicting the flight path and landing location of latex meteorological sounding balloons. ## Install @@ -15,18 +15,22 @@ The following items need to be executable (`chmod +x ./predict.py`) by the user 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 following python packages: pydap, numpy, json, simple-json. We use `at` to automatically background the predictor, so you will need that installed. -Other than that, just clone this repo to a non web-accessible folder and create symlinks to the `predict/` and `hourly-predictions/` directories in the repo. +Other than that, just clone this repo to a non web-accessible folder and create symlinks to the `predict/` directory in the repo. There are useful configuration options in `predict/includes/config.inc.php`. ## Information -The two bash 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. +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. 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. 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. +## 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. + ## Credits & Acknowledgments Credit as detailed in individual files, but notably: @@ -37,4 +41,4 @@ Credit as detailed in individual files, but notably: Adam Greig - [http://www.randomskk.net](http://www.randomskk.net) - [random@randomskk.net](mailto:random@randomskk.net) Jon Sowman - [http://www.hexoc.com](http://www.hexoc.com) - [jon@hexoc.com](mailto:jon@hexoc.com) -Copyright CUSF 2010 - All Rights Reserved +Copyright Cambridge University Spaceflight 2009-2011 - All Rights Reserved