Introduction¶
- Phoenix (the bird)
- Phoenix is a long-lived bird that is cyclically regenerated or reborn. (Wikipedia). [..]
Pyramid Phoenix is a web-application build with the Python web-framework Pyramid. Phoenix has a user interface to interact with Web Processing Services. The user interface gives you the possibility to register Web Processing Services. For these registered WPS services you can see which Processes are available. You are provided with a form page to enter the parameters to execute a process (job). You can monitor the jobs and see the results.
Phoenix is installed using the Conda Python distribution and Buildout.
Installation¶
Start with downloading Phoenix with sources from github:
$ git clone https://github.com/bird-house/pyramid-phoenix.git
$ cd pyramid-phoenix
Create the conda environment and activate it:
$ conda env create -f environment.yml
$ conda activate pyramid-phoenix
Edit the configuration custom.cfg (see custom.cfg.example). For example change the admin password:
$ vim custom.cfg
# phoenix admin password
phoenix-password = qwerty
When you’re finished, run make install to install Phoenix into the conda environment.
The installation is using buildout:
$ (pyramid-phoenix) make install
By default phoenix will be installed into the folder ~/birdhouse.
After successful installation you need to start the services:
$ (pyramid-phoenix) make start # starts supervisor services
$ (pyramid-phoenix) make status # shows status of supervisor services
Phoenix web application is available on http://localhost:8081.
Check the log file for errors:
$ tail -f ~/birdhouse/var/log/supervisor/phoenix.log
$ tail -f ~/birdhouse/var/log/supervisor/celery.log
Configuration¶
You can configure Phoenix by editing custom.cfg in the Phoenix source folder:
$ cd pyramid-phoenix
$ vim custom.cfg
$ cat custom.cfg
[settings]
hostname = localhost
http-port = 8081
https-port = 8443
log-level = INFO
# phoenix admin password
phoenix-password = qwerty
By default Phoenix runs on localhost. The HTTP port 8081 is redirected to the HTTPS port 8443.
If you want to use a different hostname/port then edit the default values in custom.cfg:
[settings]
hostname = localhost
http-port = 8081
https-port = 8443
To activate the GitHub login for external users you need to configure a GitHub application key for your Phoenix web application:
[settings]
# register at github: https://github.com/settings/applications/new
github-consumer-key = ########################
github-consumer-secret = ############################
See the GitHub Settings on how to generate the application key for Phoenix.
After any change to your custom.cfg you need to run make install again and restart the supervisor service:
$ make install
$ make restart
User Guide¶
The user guide explains how to use the Phoenix web application to interact with Web Processing Services.
Login¶
Press the Sign in button in the upper right corner.
The login page offers you several options to login to Phoenix.
You can login using your GitHub account.
If you are Phoenix admin you can also enter the admin password here.
Processes¶
When you have registered WPS services you can run a process. Go to the
Processes tab.
Choose one of your registered WPS services. You will get a list of available processes (WPS GetCapabilities request).
Choose one of these processes by using the Execute button.
In case of Emu you may try the Hello World process. You will then be
prompted to enter your username:
Press the Submit button. When the process is submitted you will be shown your job list in Monitor.
Monitor¶
In Monitor all your running or finished jobs are listed.
The list shows the status and progress of your jobs.
When a job has finished with success you can see the results by clicking the Details button.
If the result has a document (XML, text, NetCDF, …) you can view or download this document with the Download button.
My Account¶
In My Account you can change your user settings (user name, organisation, openid, …).
You can also see your current access token which you can use to access a protected WPS service directly.
Settings (admins only)¶
When you are logged-in as admin user you have the Settings page. Here you can make administrative changes and monitor services.
Register a WPS service¶
Open the Settings/Services page. Here you can see which services are registered in the catalog.
All theses services are known and usable by Phoenix.
To add a new WPS service, press the Register a new Service button and enter the WPS URL in the field Service URL.
For example, to register Emu WPS:
