Add the new content from @dbarret

Fix #14

Add the new content from @dbarret
Fix #14
Antoine Goutenoir
1 parent 77ff53d6
Showing 7 changed files with 98 additions and 29 deletions Show diff stats
README.md
content.yml
flaskr/controllers/main_controller.py
flaskr/models.py
flaskr/static/css/common/main.css
flaskr/templates/estimate.html
flaskr/templates/estimation.html
 # Travel Carbon Footprint Calculator
+- https://travel-footprint-calculator.apps.goutenoir.com  (private demo)
+- http://travel-footprint-calculator.irap.omp.eu  (official, for later)
+
+
 ## Overview
 - Content is in `content.yml`.
@@ -599,6 +599,22 @@ estimate:
       It may take from a few seconds up to a few minutes,
       depending on the amount of locations you provided.
+  help:
+    first_name: Fill these to say hello.
+    last_name: We will never share your data with anyone.
+    origin_addresses: |
+      Use <code>en_US</code> city and country names, without diacritics.
+      &nbsp;
+      The comma matters.
+      <br>
+      This is either a home city and a country
+      or the cities and countries of the participants to the conference, meeting…
+    destination_addresses: |
+      This is either the cities and countries to travel to
+      or the host city and country of the conference, meeting…
+      <br>
+      Please provide multiple cities and countries to compute the location
+      of the minimum emission.
   # Labels accept HTML, but not markdown
   # Descriptions accept neither, since we use the HTML title attribute
@@ -677,6 +693,23 @@ estimation:
         Sorry about that.  Please find the error message below.
         <br>
         Thank you for using our service.
+  lolliplot:
+    one_to_one: |
+      The carbon dioxide equivalent emission is provided for each city of destination.
+      Identical trips (i.e. identical destinations) are summed
+      and the cumulative distance is provided.
+    one_to_many: |
+      The carbon dioxide equivalent emission is provided for each city of destination.
+      Identical trips (i.e. identical destinations) are summed
+      and the cumulative distance is provided.
+    many_to_one: |
+      The carbon dioxide equivalent emission is provided for each city of origin.
+      Identical trips (i.e. identical origins) are summed and the cumulative distance is provided.
+    many_to_many: |
+      The carbon dioxide equivalent emission is summed
+      over all cities of origin and provided for each city of destination.
+      The cumulative distance to each city of destination is provided.
+      Duplicates in the destinations are removed.
 footer:
   credits: |
@@ -9,7 +9,7 @@ from os.path import join
 from flaskr.extensions import cache, basic_auth
 from flaskr.forms import LoginForm, EstimateForm
-from flaskr.models import db, User, Estimation, StatusEnum
+from flaskr.models import db, User, Estimation, StatusEnum, ScenarioEnum
 from flaskr.geocoder import CachedGeocoder
 from flaskr.core import generate_unique_id, get_emission_models
@@ -366,6 +366,7 @@ def compute():  # process the queue of estimation requests
     # for each of the Emission Models, and present a mean of all Models.
     #
     if 1 == len(origins):
+        estimation.scenario = ScenarioEnum.one_to_many
         results = compute_one_to_many(
             _origin=origins[0],
             _destinations=destinations,
@@ -377,6 +378,7 @@ def compute():  # process the queue of estimation requests
     # Same as A for now.
     #
     elif 1 == len(destinations):
+        estimation.scenario = ScenarioEnum.many_to_one
         results = compute_one_to_many(
             _origin=destinations[0],
             _destinations=origins,
@@ -388,6 +390,7 @@ def compute():  # process the queue of estimation requests
     # Run Scenario A for each Destination, and expose optimum Destination.
     #
     else:
+        estimation.scenario = ScenarioEnum.many_to_many
         unique_city_keys = []
         result_cities = []
         for destination in destinations:
@@ -24,6 +24,13 @@ class StatusEnum(enum.Enum):
     failure = 'failure'
+class ScenarioEnum(enum.Enum):
+    one_to_one = 'one_to_one'
+    many_to_one = 'many_to_one'
+    one_to_many = 'one_to_many'
+    many_to_many = 'many_to_many'
+
+
 class Estimation(db.Model):
     id = db.Column(db.Integer(), primary_key=True)
     public_id = db.Column(
@@ -42,12 +49,14 @@ class Estimation(db.Model):
     origin_addresses = db.Column(db.UnicodeText())
     destination_addresses = db.Column(db.UnicodeText())
-    # One slug per line (or blankchar?)
+    # One slug per line (or blank char?)
     models_slugs = db.Column(db.UnicodeText())
     # Deprecated, we detect this scenario from the amount of locations.
     compute_optimal_destination = db.Column(db.Boolean())
+    # Outputs
+    scenario = db.Column(db.Enum(ScenarioEnum), default=ScenarioEnum.many_to_many)
     output_yaml = db.Column(db.UnicodeText())
     warnings = db.Column(db.UnicodeText())
     errors = db.Column(db.UnicodeText())
@@ -60,10 +69,20 @@ class Estimation(db.Model):
     def get_output_dict(self):
         if self._output_dict is None:
             self._output_dict = yaml_load(self.output_yaml)
-        return self._output_dict
+            return self._output_dict
+        pass
+
+    def is_one_to_one(self):
+        return self.scenario == ScenarioEnum.one_to_one
+
+    def is_one_to_many(self):
+        return self.scenario == ScenarioEnum.one_to_many
+
+    def is_many_to_one(self):
+        return self.scenario == ScenarioEnum.many_to_one
-    def has_many_to_many(self):
-        return 'cities' in self.get_output_dict()
+    def is_many_to_many(self):
+        return self.scenario == ScenarioEnum.many_to_many
     _models = None
@@ -82,6 +101,7 @@ class EstimationView(ModelView):
         'first_name',
         'last_name',
         'models_slugs',
+        'scenario',
         'origin_addresses',
         'destination_addresses',
         'warnings',
@@ -73,7 +73,7 @@ span.required-asterisk {
 /** LISTS *********************************************************************/
 .numbered-list {
-    list-style: upper-roman;
+    list-style: decimal-leading-zero;
 }
@@ -70,11 +70,11 @@
             <div class="form-group row">
                 <div class="col-md-6">
                 {{ render_field(form.first_name) }}
-                <small class="form-text text-muted">Fill these to say hello.</small>
+                <small class="form-text text-muted">{{ content.estimate.help.first_name | safe }}</small>
                 </div>
                 <div class="col-md-6">
                 {{ render_field(form.last_name) }}
-                <small class="form-text text-muted">We will never share your data with anyone.</small>
+                <small class="form-text text-muted">{{ content.estimate.help.last_name | safe }}</small>
                 </div>
             </div>
             <div class="form-group">
@@ -83,19 +83,13 @@
             <div class="form-group">
                 {{ render_field(form.origin_addresses) }}
                 <small class="form-text text-muted">
-                    Use <code>en_US</code> city and country names, without diacritics.
-                    &nbsp;
-                    The comma matters.
-                    <br>
-                    These usually are the addresses of your participants.
+                    {{ content.estimate.help.origin_addresses | safe }}
                 </small>
             </div>
             <div class="form-group">
                 {{ render_field(form.destination_addresses) }}
                 <small class="form-text text-muted">
-                    Provide <strong>multiple destinations</strong> to compare them and <strong>compute optimum</strong>.
-                    <br>
-                    These usually are the possible locations for an event.
+                    {{ content.estimate.help.destination_addresses | safe }}
                 </small>
             </div>
 {#            <div class="form-check form-group">#}
@@ -79,21 +79,31 @@
 {% if not estimation.has_failed() %}
 {#{% set estimation_output = estimation.get_output_dict() %}#}
-{% if estimation.has_many_to_many() %}
-    <div class="col-md-6">
-    <p>
-        For each destination city, the sum of the travels from all the origins.
-    </p>
+<div class="col-md-6">
+{% if estimation.is_one_to_one() %}
+    {{ content.estimation.lolliplot.one_to_one | markdown | safe }}
+{#    <p>#}
+{#        For each destination city, the sum of the travels from all the origins.#}
+{#    </p>#}
     {{ render_cities(estimation_output.cities) }}
-    </div>
-{% else %}
-    <div class="col-md-6">
-    <p>
-        Carbon footprint for each city.
-    </p>
+{% elif estimation.is_many_to_one() %}
+    {{ content.estimation.lolliplot.many_to_one | markdown | safe }}
+{#    <p>#}
+{#        For each destination city, the sum of the travels from all the origins.#}
+{#    </p>#}
+    {{ render_cities(estimation_output.cities) }}
+{% elif estimation.is_one_to_many() %}
+    {{ content.estimation.lolliplot.one_to_many | markdown | safe }}
+
+    {{ render_cities(estimation_output.cities) }}
+{% elif estimation.is_many_to_many() %}
+    {{ content.estimation.lolliplot.many_to_many | markdown | safe }}
+{#    <p>#}
+{#        Carbon footprint for each city.#}
+{#    </p>#}
     {{ render_cities(estimation_output.cities) }}
-    </div>
 {% endif %}
+</div>
     <div class="col-md-6">
         <ul class="nav">
@@ -153,8 +163,13 @@
 {#        </pre>#}
 {#    </div>#}
 {#</div>#}
-{% endif %}
+
+{% endif %}{# estimation.has_failed() #}
 {% endblock %}
+
+{#############################################################################}
+{#############################################################################}
+
 {% block js %}
 <script src="/static/js/vendor/d3.v4.js"></script>
 <script src="/static/js/vendor/d3-legend.js"></script>