diff --git a/opendrift_leeway_webgui/leeway/templates/base.html b/opendrift_leeway_webgui/leeway/templates/base.html index 4daaf89..b24a3cc 100644 --- a/opendrift_leeway_webgui/leeway/templates/base.html +++ b/opendrift_leeway_webgui/leeway/templates/base.html @@ -10,7 +10,7 @@ Leeway Simulation - +
@@ -24,7 +24,7 @@

Source Code {% if user.is_authenticated %} - | Documentation | List of simulations | New Simulation | Logout + | Documentation | List of simulations | New Simulation | Logout {% endif %}

diff --git a/opendrift_leeway_webgui/leeway/templates/leeway/leewaysimulation_documentation.html b/opendrift_leeway_webgui/leeway/templates/leeway/leewaysimulation_documentation.html index 6bd700a..bf0b110 100644 --- a/opendrift_leeway_webgui/leeway/templates/leeway/leewaysimulation_documentation.html +++ b/opendrift_leeway_webgui/leeway/templates/leeway/leewaysimulation_documentation.html @@ -2,25 +2,41 @@ {% block content %}

Leeway Simulation Documentation

Background

-

This software acts as a web user interface for the OpenDrift Leeway model. The basis for the simulation are experiments performed by the US Coast Guard in 1999. The results are published on https://ntrl.ntis.gov, which include desriptions of the objects that were tested (2-13 and following pages).

+

+ This software acts as a web user interface for the OpenDrift Leeway model. The basis for the simulation are experiments performed by the US Coast Guard in 1999. The results are published on https://ntrl.ntis.gov, which include desriptions of the objects that were tested (2-13 and following pages). +

E-Mail Interface

-

If you have a low bandwidth connection, you can use the e-mail interface. The simulation parameters can be set in the e-mail subject. Your e-mail address needs to be registered for you user account in this tool first. The result of the simulation will be sent to your e-mail address within a couple of minutes.

+

+ If you have a low bandwidth connection, you can use the e-mail interface. The simulation parameters can be set in the e-mail subject. Your e-mail address needs to be registered for you user account in this tool first. The result of the simulation will be sent to your e-mail address within a couple of minutes. +

    -
  1. Create a new e-mail
    2. -
  2. Enter simulation parameters with adjusted values in the subject: 
    latitude=33.333;longitude=14.444;duration=48;start_time=2022-12-10 00:00:00;object_type=27
    3. -
  3. Send the mail to 
    {{ SERVER_EMAIL }}
    4. +
  4. Create a new e-mail
    5. +
  5. + Enter simulation parameters with adjusted values in the subject: 
    latitude=33.333;longitude=14.444;duration=48;start_time=2022-12-10 00:00:00;object_type=27
    +
    6. +
  6. + Send the mail to 
    {{ SERVER_EMAIL }}
    +
The default object type for simulatoins is a life raft (ID: 27). Some alternatives are:

Interpreting Simulation Result

-

When the simulation is finished, you will receive an e-mail that contains an attached image with the simulation results.

-

The simulation will randomly distribute 100 test particles around your entered coordinates. The default radius for distributing the particles is 1000 meters. If the coordinates are not very clear, you can increase this radius.

-

The starting points of the simulated particles are marked with green dots. If the particle ends up floating in water at the end of the simulation, the particle is marked blue. If the particle ends up on shore, it is marked green.

-

The image shows the trajectories of particles from the starting points to the ending points. The color of the trajectories incdicates the position of a particle at a given time. For example the color green always shows the position of the particles after ~50% of the simulated time range, while orange shows the positions at ~75%.

+

+ When the simulation is finished, you will receive an e-mail that contains an attached image with the simulation results. +

+

+ The simulation will randomly distribute 100 test particles around your entered coordinates. The default radius for distributing the particles is 1000 meters. If the coordinates are not very clear, you can increase this radius. +

+

+ The starting points of the simulated particles are marked with green dots. If the particle ends up floating in water at the end of the simulation, the particle is marked blue. If the particle ends up on shore, it is marked green. +

+

+ The image shows the trajectories of particles from the starting points to the ending points. The color of the trajectories incdicates the position of a particle at a given time. For example the color green always shows the position of the particles after ~50% of the simulated time range, while orange shows the positions at ~75%. +

{% endblock content %} diff --git a/opendrift_leeway_webgui/leeway/views.py b/opendrift_leeway_webgui/leeway/views.py index 7498600..0d1a4fc 100644 --- a/opendrift_leeway_webgui/leeway/views.py +++ b/opendrift_leeway_webgui/leeway/views.py @@ -30,7 +30,7 @@ class LeewaySimulationDocumentation(TemplateView): template_name = "leeway/leewaysimulation_documentation.html" def get_context_data(self, **kwargs): - context = super(LeewaySimulationDocumentation, self).get_context_data(**kwargs) + context = super().get_context_data(**kwargs) context["SERVER_EMAIL"] = settings.SERVER_EMAIL return context diff --git a/pyproject.toml b/pyproject.toml index 1d14aca..c4e09dd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -83,8 +83,6 @@ multi_line_output = 3 jobs = 0 load-plugins = [ "pylint_django", - "pylint.extensions.emptystring", - "pylint.extensions.comparetozero", "pylint.extensions.comparison_placement", "pylint.extensions.for_any_all", "pylint.extensions.consider_ternary_expression",