From 23f5ca0daf2f22106888667616d7f86fb1a6b3ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jean-S=C3=A9bastien=20Caux?= <git@jscaux.org>
Date: Sun, 17 Mar 2024 06:39:52 +0100
Subject: [PATCH] Add allocate_to_all_aff algorithm; work on display
---
scipost_django/finances/admin.py | 1 +
scipost_django/finances/allocate.py | 26 +++++++++++++++++--
scipost_django/finances/models/subsidy.py | 4 ++-
scipost_django/journals/models/publication.py | 23 +++++++++++++---
.../journals/publication_detail.html | 12 +++++----
5 files changed, 54 insertions(+), 12 deletions(-)
diff --git a/scipost_django/finances/admin.py b/scipost_django/finances/admin.py
index 4311d246c..1d09bb7a5 100644
--- a/scipost_django/finances/admin.py
+++ b/scipost_django/finances/admin.py
@@ -73,6 +73,7 @@ class PubFracAdmin(admin.ModelAdmin):
"doi_label_display",
"fraction",
"cf_value",
+ "compensated_by"
]
autocomplete_fields = [
"organization",
diff --git a/scipost_django/finances/allocate.py b/scipost_django/finances/allocate.py
index 124ad3766..965f2ef90 100644
--- a/scipost_django/finances/allocate.py
+++ b/scipost_django/finances/allocate.py
@@ -36,7 +36,7 @@ The algorithms are implemented in the following order,
def allocate_to_any_aff(subsidy: Subsidy):
"""
- Allocate the Subsidy to PubFracs with affiliation to Subsidy-giver.
+ Allocate to PubFracs with affiliation to Subsidy-giver.
"""
max_year = subsidy.date_until.year if subsidy.date_until else subsidy.date_from.year
uncompensated_pubfracs = PubFrac.objects.filter(
@@ -45,8 +45,30 @@ def allocate_to_any_aff(subsidy: Subsidy):
publication__publication_date__year__lte=max_year,
compensated_by__isnull=True,
)
- print(f"{uncompensated_pubfracs.count() = }")
for pubfrac in uncompensated_pubfracs.all():
if pubfrac.cf_value <= subsidy.remainder:
pubfrac.compensated_by = subsidy
pubfrac.save()
+
+
+def allocate_to_all_aff(subsidy: Subsidy):
+ """
+ Allocate to all PubFracs of Publications with at least one aff to Subsidy-giver.
+ """
+ max_year = subsidy.date_until.year if subsidy.date_until else subsidy.date_from.year
+ uncompensated_pubfracs = PubFrac.objects.filter(
+ organization=subsidy.organization,
+ publication__publication_date__year__gte=subsidy.date_from.year,
+ publication__publication_date__year__lte=max_year,
+ )
+ for pubfrac in uncompensated_pubfracs.all():
+ # retrieve all uncompensated PubFracs for the relevant Publication
+ pubfracs_for_pub = PubFrac.objects.filter(
+ publication__doi_label=pubfrac.publication.doi_label,
+ compensated_by__isnull=True,
+ )
+ print(f"{pubfracs_for_pub.all() = }")
+ for pf in pubfracs_for_pub.all():
+ if pf.cf_value <= subsidy.remainder:
+ pf.compensated_by = subsidy
+ pf.save()
diff --git a/scipost_django/finances/models/subsidy.py b/scipost_django/finances/models/subsidy.py
index c416a05d6..2ad331eb5 100644
--- a/scipost_django/finances/models/subsidy.py
+++ b/scipost_django/finances/models/subsidy.py
@@ -183,10 +183,12 @@ class Subsidy(models.Model):
"""
Allocate the funds according to the algorithm specific by the instance.
"""
- from finances.allocate import allocate_to_any_aff
+ from finances.allocate import allocate_to_any_aff, allocate_to_all_aff
if self.algorithm == self.ALGORITHM_ANY_AFF:
allocate_to_any_aff(self)
+ elif self.algorithm == self.ALGORITHM_ALL_AFF:
+ allocate_to_all_aff(self)
@property
def total_compensations(self):
diff --git a/scipost_django/journals/models/publication.py b/scipost_django/journals/models/publication.py
index 16a149325..298c0318d 100644
--- a/scipost_django/journals/models/publication.py
+++ b/scipost_django/journals/models/publication.py
@@ -324,6 +324,7 @@ class Publication(models.Model):
def get_affiliations(self):
"""Returns the Organizations mentioned in author affiliations."""
from organizations.models import Organization
+
return Organization.objects.filter(
publicationauthorstable__publication=self
).distinct()
@@ -421,9 +422,11 @@ class Publication(models.Model):
def recalculate_pubfracs(self):
"""Recalculates PubFracs using the balanced affiliations algorithm."""
- # First, rmove non-affiliation-related PubFracs
+ # First, remove non-affiliation-related PubFracs
aff_ids = [aff.id for aff in self.get_affiliations()]
- PubFrac.objects.filter(publication=self).exclude(pk__in=aff_ids).delete()
+ PubFrac.objects.filter(publication=self).exclude(
+ organization__pk__in=aff_ids
+ ).delete()
# Now recreate according to the balanced affiliations algorithm
nr_authors = self.authors.all().count()
affiliations = self.get_affiliations()
@@ -444,10 +447,17 @@ class Publication(models.Model):
publication=self,
organization=org,
).update(
- fraction=Decimal(fraction[org.id]),
+ fraction=fraction[org.id],
cf_value=value,
)
+ self.ensure_pubfracs_sum_to_1()
+ def ensure_pubfracs_sum_to_1(self):
+ """Ensure sum is 1 by putting any difference in the largest PubFrac."""
+ pubfrac_max = self.pubfracs.order_by("-fraction").first()
+ sum_pubfracs = self.pubfracs.aggregate(Sum("fraction"))["fraction__sum"]
+ pubfrac_max.fraction += 1 - sum_pubfracs
+ pubfrac_max.save()
@property
def pubfracs_sum_to_1(self):
@@ -458,7 +468,12 @@ class Publication(models.Model):
def compensated_expenditures(self):
"""Compensated part of expenditures for this Publication."""
qs = self.pubfracs.filter(compensated_by__isnull=False)
- return qs.aggregate(Sum("cf_value"))["cf_value__sum"] if qs.exists() else 0
+ # Use the fraction to obtain an accurate result
+ return int(
+ qs.aggregate(Sum("fraction"))["fraction__sum"] * self.expenditures
+ if qs.exists()
+ else 0
+ )
@property
def uncompensated_expenditures(self):
diff --git a/scipost_django/journals/templates/journals/publication_detail.html b/scipost_django/journals/templates/journals/publication_detail.html
index b55c9f3c2..6b1d9dff5 100644
--- a/scipost_django/journals/templates/journals/publication_detail.html
+++ b/scipost_django/journals/templates/journals/publication_detail.html
@@ -193,13 +193,15 @@
{% if pubfrac.compensated %}
<td class="bg-success bg-opacity-25">
by <a href="{% url 'organizations:organization_detail' pk=pubfrac.compensated_by.organization.id %}">{{ pubfrac.compensated_by.organization }}</a>
- (<a href="{% url 'finances:subsidy_details' pk=pubfrac.compensated_by.id %}">
+  (<a href="{% url 'finances:subsidy_details' pk=pubfrac.compensated_by.id %}">
see Subsidy details
</a>)
</td>
<td class="bg-success bg-opacity-25">€0</td>
{% else %}
- <td><span class="text-danger">{% include 'bi/x-circle-fill.html' %}</span></td>
+ <td class="bg-danger bg-opacity-25">
+ <span class="text-danger">{% include 'bi/x-circle-fill.html' %}</span>
+ </td>
<td class="bg-danger bg-opacity-25">€{{ pubfrac.cf_value }}</td>
{% endif %}
</tr>
@@ -208,9 +210,9 @@
<tr>
<th>Totals</th>
<td>1</td>
- <td>{{ publication.expenditures }}</td>
- <td class="{% if uncompensated == 0 %}bg-success{% else %}bg-danger{% endif %} bg-opacity-25">{{ publication.compensated_expenditures }}</td>
- <td class="{% if uncompensated == 0 %}bg-success{% else %}bg-danger{% endif %} bg-opacity-25">{{ publication.uncompensated_expenditures }}</td>
+ <td>€{{ publication.expenditures }}</td>
+ <td class="{% if uncompensated == 0 %}bg-success{% else %}bg-danger{% endif %} bg-opacity-25">€{{ publication.compensated_expenditures }}</td>
+ <td class="{% if uncompensated == 0 %}bg-success{% else %}bg-danger{% endif %} bg-opacity-25">€{{ publication.uncompensated_expenditures }}</td>
</tr>
{% endwith %}
</tbody>
--
GitLab