@@ -59,8 +59,7 @@ The official Django documentation for this [can be found here](https://docs.djan
...
@@ -59,8 +59,7 @@ The official Django documentation for this [can be found here](https://docs.djan
```
```
## Developer guide
## Instance configuration
### Instance configuration
Each installation of VIPSWeb can be customized in several ways
Each installation of VIPSWeb can be customized in several ways
* The page title
* The page title
* Site owner/URL
* Site owner/URL
...
@@ -80,14 +79,14 @@ This is done by making a copy of `local_settings_sample.py` to `local_settings.p
...
@@ -80,14 +79,14 @@ This is done by making a copy of `local_settings_sample.py` to `local_settings.p
### Showing a new model in the detail page (forecasts app)
## Showing a new model in the detail page (forecasts app)
The VIPSWeb app has the tools to display results from model calculations. It fetches the data from the VIPSLogic backend. Each model has its own characteristics, and VIPSWeb needs to be told how to display the results from each model.
The VIPSWeb app has the tools to display results from model calculations. It fetches the data from the VIPSLogic backend. Each model has its own characteristics, and VIPSWeb needs to be told how to display the results from each model.
![Detail view of results from an Apple scab model forecast](./docs/illustrations/detail_page.png"Detail view of results from an Apple scab model forecast")
![Detail view of results from an Apple scab model forecast](./docs/illustrations/detail_page.png"Detail view of results from an Apple scab model forecast")
This has to be configured in the admin section of Django. Log in as administrator, or [create one](https://docs.djangoproject.com/en/3.1/intro/tutorial02/#creating-an-admin-user) if you haven't already.
This has to be configured in the admin section of Django. Log in as administrator, or [create one](https://docs.djangoproject.com/en/3.1/intro/tutorial02/#creating-an-admin-user) if you haven't already.
#### Add result parameters for the model
### Add result parameters for the model
For each model, you have to specify the parameters (returned from the model calculations) that should be displayed in the table and in the diagram. All result parameters specified will be displayed in the table, but only the ones configured as "Model graph parameters" will be shown in the chart.
For each model, you have to specify the parameters (returned from the model calculations) that should be displayed in the table and in the diagram. All result parameters specified will be displayed in the table, but only the ones configured as "Model graph parameters" will be shown in the chart.
Add a result parameter by clicking as shown below
Add a result parameter by clicking as shown below
...
@@ -110,7 +109,7 @@ After saving, the parameter is listed among all the others in the VIPSWeb applic
...
@@ -110,7 +109,7 @@ After saving, the parameter is listed among all the others in the VIPSWeb applic
![The list of result parameters](./docs/illustrations/add_result_param_3.png"The list of result parameters")
![The list of result parameters](./docs/illustrations/add_result_param_3.png"The list of result parameters")
#### Configure a result parameter to be shown in the chart
### Configure a result parameter to be shown in the chart
VIPSWeb uses [Highcharts](https://www.highcharts.com/) to generate charts, coupled with our own parameter-to-chart logic. **It's on our TODO list to replace Highcharts** To make the chart library recognize a chart parameter and tell it how it should be displayed, click "Add" in "Model graph parameters" as shown below.
VIPSWeb uses [Highcharts](https://www.highcharts.com/) to generate charts, coupled with our own parameter-to-chart logic. **It's on our TODO list to replace Highcharts** To make the chart library recognize a chart parameter and tell it how it should be displayed, click "Add" in "Model graph parameters" as shown below.
![Click Add to add a new model chart parameter](./docs/illustrations/add_result_param_4.png"Click Add to add a new model chart parameter")
![Click Add to add a new model chart parameter](./docs/illustrations/add_result_param_4.png"Click Add to add a new model chart parameter")
