Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
openpap:start [2008-05-13 14:49:14] rikardb |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== OpenPAP ====== | ||
- | |||
- | ===== Introduction ===== | ||
- | OpenPAP is a system that produces graphical complex weather elements for newspapers. The majority of the system may run on many platforms but this release is focused on Windows (XP) only. | ||
- | |||
- | |||
- | ===== Requirements ===== | ||
- | * Windows XP | ||
- | * Java JRE 1.6 or higher | ||
- | * PostgreSQL 8.3 or higher | ||
- | * Microsoft .NET Framework 2.0 or higher | ||
- | * Adbobe InDesign CS3 or higher | ||
- | |||
- | |||
- | ===== Components ===== | ||
- | * PostgreSQL database dump, weather database | ||
- | * OpenPAPXml.jar - command line program to produce XML for Abode InDesign | ||
- | * OpenPAPProducer - Windows program, runs the automated production against Adobe InDesign | ||
- | * OpenPAPCorrGUI.jar - Java GUI program, edit the productiontable in the database | ||
- | * OpenPAPAdmGUI.jar - Java GUI program, make new customers, and select what data that should be available to them | ||
- | |||
- | |||
- | ===== Datasources ===== | ||
- | * NAAF - pollen data | ||
- | * api.met.no - forecast data, uv data, extreme observation data | ||
- | * eKlima - observation data | ||
- | * weather db - facttext data | ||
- | * Sjøkartverket/ | ||
- | |||
- | |||
- | |||
- | ===== Download ===== | ||
- | * [[http:// | ||
- | |||
- | ===== Installation ===== | ||
- | |||
- | === The requirements === | ||
- | |||
- | == Java JRE 1.6: == | ||
- | * See http:// | ||
- | |||
- | |||
- | == Adobe InDesign CS3: == | ||
- | * See http:// | ||
- | |||
- | |||
- | == .Net framework 2.0: == | ||
- | * See http:// | ||
- | |||
- | |||
- | == PostgreSQL 8.3: == | ||
- | * Download PostgreSQL from http:// | ||
- | * You **don' | ||
- | * Install it as a service | ||
- | * Accept connections on all addresses, not just on localhost - If you are planning to run the system on not just one computer | ||
- | * Locale: C Encoding: LATIN-5 | ||
- | * superuser: postgres password: Post#Gres!1 (this is the default username/ | ||
- | * No contrib modules is needed | ||
- | |||
- | |||
- | |||
- | |||
- | === The OpenPAP package === | ||
- | |||
- | * Extract OpenPAP.zip into c:\. This will result in the following structure: | ||
- | |||
- | c:\OpenPAP\ | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | c: | ||
- | |||
- | |||
- | |||
- | == Database: == | ||
- | * Restore the default weather database into your new PostgreSQl 8.3 | ||
- | * Start pgadmin III from the Windows start menu | ||
- | * In pgadmin III, go to menu " | ||
- | * Select " | ||
- | * Select the new database " | ||
- | * Exit pgadmin III | ||
- | |||
- | == Config: == | ||
- | * Open c: | ||
- | * Edit smtp server by changing the value of after smtp. For instance: smtp=smtp.chello.no | ||
- | * Edit OpenPAPXml_email_to (multiple as commaseparated) and OpenPAPXml_email_from. This is email warning when something goes wrong during XML production. | ||
- | * Edit database properties if you have installed the database on another machine or you have not been using the | ||
- | * Edit OpenPAPProducer_email_to (multiple as commaseparated) and OpenPAPProducer_email_from. This is email warning when something goes wrong during InDesign production. | ||
- | * Edit the path's if you have different file structure | ||
- | |||
- | == OpenPAPProducer: | ||
- | * Start c: | ||
- | |||
- | |||
- | ===== Usage ===== | ||
- | |||
- | === Example customer === | ||
- | The example customer Test_Oslo with customerid 1 comes with the package. | ||
- | It's a good idea to test your installation by producing this customer. | ||
- | This is how you proceed: | ||
- | * Run OpenPAPProducer | ||
- | * Select customer " | ||
- | The OpenPAPProducer window provides status and progressinfo. | ||
- | First you see a DOS window, this is OpenPAPXml prepearing the XML file with data for Adbobe Indesign. Then Abobe InDesign starts and run's the template for Test_Oslo. It finnishes by exporting PDF and EPS into the output directory. If not changed this is c: | ||
- | |||
- | === Make your own === | ||
- | If the example runned smoothly you are ready to produce your very own product. | ||
- | * Find out **what data you would like** to include in the final product | ||
- | * Create a **static background picture** in for instance Adobe Illustrator. This would normally contain | ||
- | * empty maps | ||
- | * tables containing nothing but location names and columnnames | ||
- | * empty space for facttexts, textforecasts and so on | ||
- | * Depending on what data you want, you may need some **extra graphics**, for instance weather symbols and wind arrows. All kinds of extra graphics are located in the graphics folder for the test-customer. Take a look there to understand the file naming and create your own sets. | ||
- | * Start **OpenPAPAdmGUI** | ||
- | * **Create the customer** | ||
- | * **Add metadata for the customer**, for instance model data for a selected amount of locations, parameters and days. Metagroup is best used by using names based on each graphical element in the Adobe InDesign template. For instance, if you are selecting stations and parameters for a Europe weather map, set metagroup to " | ||
- | * **Add stations** inn the station if you can't find your desired station/ | ||
- | * **Create a customer folder** in c: | ||
- | * Now you are ready to **produce the XML** for Adbobe InDesign | ||
- | * Start OpenPAPProducer | ||
- | * Select your customer from the dropdown menu and clik the appearing Produce button. This will fail after creating XML because Adobe Indesign is not set up yet. This is **OK**. We still get the XML and that's all we want now. The XML should be located in c: | ||
- | * Start Abobe InDesign. | ||
- | * Create a **new blank template**. | ||
- | * Add the **background image** created earlier, as a layer | ||
- | * Provide boxes for every spot you wish to fill with data. The boxes are made by using " | ||
- | * **Import XML** from File menu. The XML is located in c: | ||
- | * Start **dragging from XML** and dropping on each element in your Adobe InDesign template. | ||
- | * You may experience that the weather symbols are too large, this can be fixed by naming the layer they belong to with a reserved ending, " **scale [1-100]**" | ||
- | * If you wish to turn som **layers on or off** at a spesific time in the year you may do this in the OpenPAPAdmGUI program. Write down the layer names you wish to turn on/off. | ||
- | * **Save template** and exit Adobe InDesign. | ||
- | * Start OpenPAPAdmGUI | ||
- | * Go to the " | ||
- | * Select you customer and click " | ||
- | * Write the layer name and make sure that active is selected. That makes this layer active. Type in start- and enddate in the ddMM format, for instance 2901 for January 29. You can also choose wintertime or summertime as start- and enddate. | ||
- | * Start OpenPAPProducer | ||
- | * Select your customer from the dropdown menu and **clik the appearing Produce button**. | ||
- | * The OpenPAPProducer window provides status and progressinfo. First you see a DOS window, this is **OpenPAPXml** prepearing the XML file with data for Adbobe Indesign. Then **Abobe InDesign** starts and run's the template for your customer. It finnishes by exporting PDF and EPS into the output directory, **c: | ||
- | |||
- | |||
- | ===== Production ===== | ||
- | === Scheduled production === | ||
- | When you are all set to produce the customer you may want to do it automated at specific times. This can be done by using " | ||
- | * Make a bat-file that writes an empty file with customer id as file name to c: | ||
- | * Then edit your new c: | ||
- | * Open " | ||
- | * Start OpenPAPProducer | ||
- | * Test the production by manually running c: | ||
- | |||
- | === Manual production === | ||
- | * Start OpenPAPProducer | ||
- | * Select customer and click the produce button | ||
- | |||
- | === Special production - OpenPAPCorrGUI Produce === | ||
- | This option shall be used after doing corrections in the customer data with OpenPAPCorrGUI. OpenPAPCorrGUI is typically used after a production with reported some missing data. Use OpenPAPCorrGUI to edit the missing/ | ||
- | * Start OpenPAPCorrGUI | ||
- | * Select the customer that need data edit | ||
- | * Edit the missing/ | ||
- | * Start OpenPAPProducer | ||
- | * If you start a normal production for this customer the data you corrected will be overwritten with missing/ | ||
- | |||
- | |||
- | |||
- | ===== Data and parameters supported ===== | ||
- | |||
- | **(1) Model data, forecast** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 8206 | GRAPHICS_INDT | ||
- | | 8445 | TEXTFORECAST | ||
- | | 8900 | GRILLINDEX | ||
- | | 9885 | WINDARROW_8_COLOR | ||
- | | 9985 | WINDARROW_8 | ||
- | | 9987 | WIND_INTERVAL | ||
- | | 9988 | PREC_INTERVAL | ||
- | | 9990 | WEATHERTXT | ||
- | | 9991 | WINDTYPE_TXT | ||
- | | 9994 | PRECIPITATION | ||
- | | 9995 | WIND_SPEED | ||
- | | 9996 | TEMPERATURE | ||
- | | 9998 | WINDARROW | ||
- | | 9999 | WSYMBOL | ||
- | |||
- | **(5) Sun Moon Tidalwater** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 8000 | TV_H1 | -n | n | | ||
- | | 8001 | TV_H2 | -n | n | | ||
- | | 8002 | TV_L1 | -n | n | | ||
- | | 8003 | TV_L2 | -n | n | | ||
- | | 8004 | TV_H1_CM | -n | n | | ||
- | | 8005 | TV_H2_CM | -n | n | | ||
- | | 8006 | TV_L1_CM | -n | n | | ||
- | | 8007 | TV_L2_CM | -n | n | | ||
- | | 8101 | SUN_UP | -n | n | | ||
- | | 8102 | SUN_DOWN | -n | n | | ||
- | | 8103 | MOON_UP | -n | n | | ||
- | | 8104 | MOON_DOWN | -n | n | | ||
- | | 8106 | SUN_LENGTH | -n | n | | ||
- | | 8107 | DAYS_SUN_RETURN | 1 | 1 | | ||
- | | 8108 | SINCE_S_W_PHASEDESC | 1 | 1 | | ||
- | |||
- | **(6) Observations** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 9989 | SNOW_DEPTH | -n | 0 | | ||
- | | 9990 | WEATHERTXT | -n | 0 | | ||
- | | 9991 | WINDTYPE_TXT | -n | 0 | | ||
- | | 9992 | TEMPERATURE_MIN | -n | 0 | | ||
- | | 9993 | TEMPERATURE_MAX | -n | 0 | | ||
- | | 9994 | PRECIPITATION | -n | 0 | | ||
- | | 9995 | WIND_SPEED | -n | 0 | | ||
- | | 9996 | TEMPERATURE | -n | 0 | | ||
- | | 9998 | WINDARROW | -n | 0 | | ||
- | | 9999 | WSYMBOL | -n | 0 | | ||
- | | 9820 | MULTIRES_WARMEST | 0 | 0 | | ||
- | | 9821 | MULTIRES_COLDEST | 0 | 0 | | ||
- | | 9822 | MULTIRES_MOST_WET | 0 | 0 | | ||
- | | 9823 | MULTIRES_MOST_WINDY | 0 | 0 | | ||
- | | 9824 | MULTIRES_MOST_SUNNY | 0 | 0 | | ||
- | |||
- | **(7) Moon phases** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 8105 | GRAPHICS_MOONFACE | -n | n | | ||
- | |||
- | **(8) Fact texts** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 8400 | FACTTEXT | 1 | 1 | | ||
- | |||
- | **(14) Time - days, dates** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 9000 | DAYOFWEEK_FULL | -n | n | | ||
- | | 9001 | DAYOFWEEK_3CHAR | -n | n | | ||
- | | 9002 | DAYOFWEEK_2CHAR | -n | n | | ||
- | | 9010 | MONTH_FULL | -n | n | | ||
- | | 9011 | MONTH_3CHAR | -n | n | | ||
- | | 9020 | DATES_YEAR | -n | n | | ||
- | | 9021 | DATES_YEAR_SHORT | -n | n | | ||
- | | 9022 | DATES_MONTH | -n | n | | ||
- | | 9023 | DATES_DAY | -n | n | | ||
- | | 9024 | DATES_FULL | -n | n | | ||
- | |||
- | **(16) Pollen forecast** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 8109 | POLLEN_OR | 0 | 1 | | ||
- | | 8110 | POLLEN_HASSEL | 0 | 1 | | ||
- | | 8111 | POLLEN_BJØRK | 0 | 1 | | ||
- | | 8112 | POLLEN_GRESS | 0 | 1 | | ||
- | | 8113 | POLLEN_BUROT | 0 | 1 | | ||
- | |||
- | **(20) UV forecast** | ||
- | ^ Parameter id ^ Parameter Name ^ Datestart ^ Dateend ^ | ||
- | | 8210 | GRAPHICS_UVINDEX | 0 | 3 | | ||
- | |||
- | |||
- | ===== Overview ===== | ||
- | |||
- | ==== Administration ==== | ||
- | {{: | ||
- | ==== Production ==== | ||
- | {{: | ||
- | |||
- | |||
- | |||
- | ===== Features ===== | ||
- | |||
- | === Tidalwater - Special handling === | ||
- | Tidalwater is not a free source and is not available with HTTP GET or web services, so you have to import an ordered file into the database with a special script. This is for norwegian tidalwater data: | ||
- | * Contact " | ||
- | * Run the tidalwater parser from commandline. perl needs to be installed to run it. Run command: " | ||
- | * This should result in a series of INSERT statements. Copy this into PgAdmin III and run them in a SQL window. | ||
- | * Tidalwater is now in the database and you are free to use tidalwater data. | ||
- | |||
- | |||
- | === Pollen data - Special handling === | ||
- | * To get the norwegian pollen data from NAAF into pap you will have to contact NAAF for a user id. | ||
- | * Place the userId into c: | ||
- | |||
- | |||
- | ===== TODO - made 2008-04-21 ===== | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * < | ||
- | * Implementation adminGUI | ||
- | * Testing adminGUI | ||
- | * Documentation | ||
- | * Test: install and testrun of example customer | ||
- | * Test: setup of new customer and scheduled run | ||
- | * javadoc in OpenPapXml.jar | ||
- | * Open source info in code and wiki page | ||
- | * Last fixes in OpenPAPCorrAPP.jar | ||
- | * Last fixes in OpenPAPXml.jar | ||
- | * Last fixes in weather database | ||
- | * Last fixes in OpenPAPProducer | ||
- | * Datavalue check, quality-assured | ||
- | * General testing | ||
- | * Bugfix | ||