wbportfolio 2.2.4__py2.py3-none-any.whl → 2.2.6__py2.py3-none-any.whl

wbportfolio/fixtures/product_factsheets.yaml

@@ -0,0 +1 @@
+[{"model": "wbreport.colorgradient", "pk": 1, "fields": {"title": "Default Color Palette", "colors": "[\"#ffb166\", \"#d1c554\", \"#8cd66b\", \"#5fd785\", \"#05d6a1\", \"#00c1ab\", \"#01abaa\", \"#38c1d7\", \"#70d6ff\", \"#00b1ff\", \"#0585ff\", \"#2a5df2\", \"#5724d9\", \"#823edf\", \"#a359e5\", \"#e13da9\", \"#ef476f\"]"}}, {"model": "wbreport.reportasset", "pk": 1, "fields": {"key": "font-default", "description": "", "text": "", "asset": "report/assets/Roboto-Light.ttf"}}, {"model": "wbreport.reportasset", "pk": 2, "fields": {"key": "font-bd", "description": "", "text": "", "asset": "report/assets/Roboto-Medium.ttf"}}, {"model": "wbreport.reportasset", "pk": 3, "fields": {"key": "font-it", "description": "", "text": "", "asset": "report/assets/Roboto-LightItalic.ttf"}}, {"model": "wbreport.reportcategory", "pk": 1, "fields": {"title": "Test", "order": 0}}, {"model": "wbreport.reportclass", "pk": 1, "fields": {"title": "Base Product Report Class", "class_path": "wbreport.defaults.factsheets.base"}}, {"model": "wbreport.reportclass", "pk": 2, "fields": {"title": "Multindex Report Class", "class_path": "wbreport.defaults.factsheets.multitheme"}}, {"model": "wbreport.reportclass", "pk": 3, "fields": {"title": "Menu Report Class", "class_path": "wbreport.defaults.factsheets.menu"}}, {"model": "wbreport.report", "pk": 1, "fields": {"content_type": 67, "object_id": 566, "file_content_type": "PDF", "category": null, "parent_report": 5, "is_active": true, "file_disabled": false, "base_color": "#70D6FF", "is_private": false, "mailing_list": null, "report_class": 1, "title": "Base Index Factsheet", "namespace": "base-index-factsheet", "logo_file": "", "color_palette": 1}}, {"model": "wbreport.report", "pk": 2, "fields": {"content_type": 67, "object_id": 567, "file_content_type": "PDF", "category": null, "parent_report": 5, "is_active": true, "file_disabled": false, "base_color": "#05D6A1", "is_private": false, "mailing_list": null, "report_class": 1, "title": "Base Product Factsheet", "namespace": "base-product-factsheet", "logo_file": "", "color_palette": 1}}, {"model": "wbreport.report", "pk": 3, "fields": {"content_type": 67, "object_id": 629, "file_content_type": "PDF", "category": null, "parent_report": 5, "is_active": true, "file_disabled": false, "base_color": "#FFB166", "is_private": false, "mailing_list": null, "report_class": 2, "title": "Multi Indexes Factsheet", "namespace": "multi-indexes", "logo_file": "", "color_palette": 1}}, {"model": "wbreport.report", "pk": 4, "fields": {"content_type": 67, "object_id": 613, "file_content_type": "PDF", "category": null, "parent_report": 5, "is_active": true, "file_disabled": false, "base_color": "#EF476F", "is_private": false, "mailing_list": null, "report_class": 1, "title": "Share class Factsheet", "namespace": "share-class-factsheet", "logo_file": "", "color_palette": 1}}, {"model": "wbreport.report", "pk": 5, "fields": {"content_type": null, "object_id": null, "file_content_type": "PDF", "category": null, "parent_report": null, "is_active": true, "file_disabled": false, "base_color": "#FFF000", "is_private": false, "mailing_list": null, "report_class": 3, "title": "Factsheet", "namespace": "factsheet", "logo_file": "", "color_palette": 1}}, {"model": "wbreport.reportversion", "pk": 1, "fields": {"uuid": "9ebd8023-7ebb-4389-a484-410c7c4aad2a", "lookup": "august-2021", "title": "August 2021", "parameters": {"end": "2021-08-31", "start": "2021-07-30"}, "context": {}, "version_date": "2021-11-09", "creation_date": "2021-11-09T10:15:28.539Z", "update_date": "2021-11-09T13:00:00.665Z", "comment": "", "is_primary": true, "disabled": false, "report": 5}}, {"model": "wbreport.reportversion", "pk": 2, "fields": {"uuid": "8a675145-249e-4183-8f19-5cb023fce8c7", "lookup": "factsheet-august-2021", "title": "Share class - August 2021", "parameters": {"end": "2021-08-31", "start": "2021-07-30"}, "context": {}, "version_date": "2021-11-09", "creation_date": "2021-11-09T10:18:20.567Z", "update_date": "2021-11-09T13:00:01.418Z", "comment": "", "is_primary": true, "disabled": false, "report": 4}}, {"model": "wbreport.reportversion", "pk": 4, "fields": {"uuid": "8e186d05-5298-4ab3-bc0b-6a81398e622a", "lookup": "factsheet-mutli-index-august-2021", "title": "Mutli Index - August 2021", "parameters": {"end": "2021-08-31", "start": "2021-07-30"}, "context": {}, "version_date": "2021-11-09", "creation_date": "2021-11-09T10:19:05.102Z", "update_date": "2021-11-09T13:00:01.962Z", "comment": "", "is_primary": true, "disabled": false, "report": 3}}, {"model": "wbreport.reportversion", "pk": 6, "fields": {"uuid": "825c101e-54ec-4197-ad8a-678bcd6431dd", "lookup": "factsheet-base-product-august-2021", "title": "Base product - August 2021", "parameters": {"end": "2021-08-31", "start": "2021-07-30"}, "context": {}, "version_date": "2021-11-09", "creation_date": "2021-11-09T10:19:41.464Z", "update_date": "2021-11-09T13:00:02.271Z", "comment": "", "is_primary": true, "disabled": false, "report": 2}}, {"model": "wbreport.reportversion", "pk": 7, "fields": {"uuid": "5e1014f0-f211-4b81-b272-4d5284d7ef8c", "lookup": "factsheet-base-index-august-2021", "title": "Base Index - August 2021", "parameters": {"end": "2021-08-31", "start": "2021-07-30"}, "context": {}, "version_date": "2021-11-09", "creation_date": "2021-11-09T10:19:54.422Z", "update_date": "2021-11-09T13:00:02.616Z", "comment": "", "is_primary": true, "disabled": false, "report": 1}}]

wbportfolio/import_export/backends/refinitiv/adjustment.py

@@ -0,0 +1,40 @@
+from datetime import datetime
+from io import BytesIO
+from typing import Optional
+
+from django.db import models
+from pandas.tseries.offsets import BDay
+from wbcore.contrib.io.backends import AbstractDataBackend, register
+from wbfdm.import_export.backends.refinitiv.utils import Controller
+from wbportfolio.import_export.backends.utils import (
+    get_timedelta_import_instrument_price,
+)
+
+from ..wbfdm.mixin import DataBackendMixin
+
+DEFAULT_MAPPING = {"AX": "factor"}
+
+
+@register("Adjustment", provider_key="refinitiv")
+class DataBackend(DataBackendMixin, AbstractDataBackend):
+    CHUNK_SIZE = 50
+
+    def __init__(self, import_credential: Optional[models.Model] = None, **kwargs):
+        self.controller = Controller(import_credential.username, import_credential.password)
+
+    def get_files(
+        self,
+        execution_time: datetime,
+        obj_external_ids: list[str] = None,
+        **kwargs,
+    ) -> BytesIO:
+        execution_date = execution_time.date()
+        start = kwargs.get("start", (execution_date - BDay(get_timedelta_import_instrument_price())).date())
+        fields = list(DEFAULT_MAPPING.keys())
+        if obj_external_ids:
+            df = self.controller.get_data(obj_external_ids, fields, start, execution_date)
+            if not df.empty:
+                content_file = BytesIO()
+                df.to_json(content_file, orient="records")
+                file_name = f"adjustment_chunk-{start:%Y-%m-%d}-{execution_date:%Y-%m-%d}_{datetime.timestamp(execution_time)}.json"
+                yield file_name, content_file

wbportfolio/jinja2/wbportfolio/sql/aum_nnm.sql

@@ -0,0 +1,119 @@
+-- CTE for prices that fetch prices per product converted to USD
+WITH prices AS (
+    SELECT
+        price.date AS date,
+        price.instrument_id AS instrument_id,
+        price.net_value AS net_value,
+        price.net_value * (1 / fx.value) AS net_value_usd
+    FROM wbfdm_instrumentprice AS price
+    JOIN currency_currencyfxrates AS fx ON price.currency_fx_rate_to_usd_id = fx.id
+    WHERE price.calculated = FALSE
+),
+-- CTE for claims, that fetches approved claims
+claims AS (
+    SELECT
+        claim.shares,
+        claim.date,
+        claim.product_id,
+        account.tree_id AS tree_id,
+        trade.marked_as_internal AS marked_as_internal
+    FROM wbportfolio_claim AS claim
+    JOIN wbcrm_account AS account
+        ON claim.account_id = account.id
+    JOIN wbportfolio_trade AS trade
+        ON claim.trade_id = trade.transaction_ptr_id
+    WHERE claim.status = 'APPROVED'
+),
+-- CTE for claims, that fetches them with their shares and price at transaction date
+claims_with_nav AS (
+    SELECT
+        claims.date,
+        claims.shares,
+        claims.product_id,
+        nav.net_value_usd,
+        accounts.tree_id AS tree_id,
+        trade.marked_as_internal as marked_as_internal
+    FROM wbportfolio_claim AS claims
+   JOIN wbportfolio_trade AS trade
+        ON claims.trade_id = trade.transaction_ptr_id
+    LEFT JOIN wbcrm_account AS accounts
+        ON claims.account_id = accounts.id
+    LEFT JOIN LATERAL (
+        SELECT
+            price.net_value * (1 / cc.value) AS net_value_usd
+        FROM wbfdm_instrumentprice AS price
+        LEFT JOIN currency_currencyfxrates AS cc
+            ON cc.id = price.currency_fx_rate_to_usd_id
+        WHERE
+            price.instrument_id = claims.product_id
+            AND price.date <= claims.date
+            AND claims.status = 'APPROVED'
+            AND claims.account_id IS NOT NULL
+            AND price.calculated = FALSE
+        ORDER BY price.date DESC
+        LIMIT 1
+    ) AS nav ON TRUE
+-- CTE to generate a series with year and month already extracted
+), series AS (
+    SELECT
+        (DATE_TRUNC('month', dts) + INTERVAL '1 month - 1 day')::DATE AS val_date,
+        EXTRACT(YEAR FROM dts) AS year,
+        EXTRACT(MONTH FROM dts) AS month
+    FROM GENERATE_SERIES('{{ from_date | identifier }}'::DATE, '{{ to_date | identifier }}'::DATE, '1 month'::INTERVAL) AS dts
+)
+
+SELECT
+    series.year AS year,
+    series.month AS month,
+    SUM(NAV.net_value_usd * HOLDINGS.sum_shares) AS total_assets,
+    SUM(COALESCE(NNM.nnm_usd, 0)) AS net_new_money
+
+FROM series
+-- Cartesian product with products, to get each item of the series
+-- for each product
+CROSS JOIN wbportfolio_product AS product
+
+-- If there is not product_id it means we filter for all products
+-- This means we have to filter out all products that are not
+-- invested to avoid double accounting
+
+-- Foreach product/date combination, get the last NAV date available
+LEFT JOIN LATERAL (
+    SELECT prices.net_value_usd
+    FROM prices
+    WHERE
+        prices.date <= series.val_date
+        AND prices.instrument_id = product.instrument_ptr_id
+    ORDER BY prices.date DESC
+    LIMIT 1
+) AS NAV ON TRUE
+-- For each product/date combination, get the number of shares
+LEFT JOIN LATERAL (
+    SELECT SUM(claims.shares) AS sum_shares
+    FROM claims
+    WHERE claims.date <= series.val_date
+      AND claims.product_id = product.instrument_ptr_id
+      {% if account_tree_id %}AND claims.tree_id={{ account_tree_id }}{% endif %}
+      {% if not product_id %}AND claims.marked_as_internal=False{% endif %}
+) AS HOLDINGS ON TRUE
+-- For each product/date combination, get the NNM
+LEFT JOIN LATERAL (
+    -- Get the number of shares that were created in the month of date (from the series)
+    SELECT
+        SUM(claims.shares * claims.net_value_usd) AS nnm_usd,
+        SUM(claims.shares) as shares
+    FROM claims_with_nav as claims
+    WHERE
+        EXTRACT(YEAR FROM claims.date) = series.year
+        AND EXTRACT(MONTH FROM claims.date) = series.month
+        AND claims.product_id = product.instrument_ptr_id
+        {% if account_tree_id %}AND claims.tree_id={{ account_tree_id }}{% endif %}
+        {% if not product_id %}AND claims.marked_as_internal=False{% endif %}
+    ) AS NNM ON TRUE
+
+-- if we pass in the product_id, we only display the data for this particular product
+{% if product_id %}
+WHERE product.instrument_ptr_id = {{ product_id }}
+{% endif %}
+
+GROUP BY series.year, series.month

wbportfolio/kpi_handlers/nnm.py

@@ -0,0 +1,163 @@
+from decimal import Decimal
+from typing import Type
+
+from django.db.models import Exists, OuterRef, Sum
+from django.db.models.expressions import F
+from django.db.models.functions import Coalesce
+from django.db.models.query import QuerySet
+from wbcore import serializers
+from wbcore.contrib.currency.models import CurrencyFXRates
+from wbcore.serializers.serializers import Serializer
+from wbcrm.models import Account
+from wbhuman_resources.models.kpi import KPI, KPIHandler
+from wbhuman_resources.serializers import KPIModelSerializer
+from wbportfolio.models.transactions.claim import Claim
+
+
+class NetNewMoneyKPISerializer(KPIModelSerializer):
+    transaction_subtype = serializers.ChoiceField(
+        default="all",
+        choices=[("SUBSCRIPTION", "Only Subscriptions"), ("REDEMPTION", "Only Redemptions"), ("all", "All")],
+    )
+    nnm_from = serializers.ChoiceField(
+        default="all",
+        label="NNM from",
+        choices=[("new_clients", "New clients"), ("existing_clients", "Existing clients"), ("all", "All")],
+    )
+    only_approved = serializers.BooleanField(
+        default=False, label="Only Approved claims", help_text="Filter only approve claims"
+    )
+
+    creator = serializers.BooleanField(
+        default=True, label="Creator of claim", help_text="NNM considered are related to the creator of claim"
+    )
+    claimant = serializers.BooleanField(
+        default=True, label="Claimant of claim", help_text="NNM considered are related to the claimant"
+    )
+    in_charge_of_customer = serializers.BooleanField(
+        default=True,
+        label="In charge of customer",
+        help_text="NNM considered are related to the persons in charge of customer",
+    )
+
+    def update(self, instance, validated_data):
+        transaction_subtype = validated_data.get(
+            "transaction_subtype",
+            instance.additional_data["serializer_data"].get("transaction_subtype", "all"),
+        )
+        only_approved = validated_data.get(
+            "only_approved",
+            instance.additional_data["serializer_data"].get("only_approved", False),
+        )
+        nnm_from = validated_data.get(
+            "nnm_from",
+            instance.additional_data["serializer_data"].get("nnm_from", "all"),
+        )
+
+        creator = validated_data.get(
+            "creator",
+            instance.additional_data["serializer_data"].get("creator", True),
+        )
+        claimant = validated_data.get(
+            "claimant",
+            instance.additional_data["serializer_data"].get("claimant", True),
+        )
+        in_charge_of_customer = validated_data.get(
+            "in_charge_of_customer",
+            instance.additional_data["serializer_data"].get("in_charge_of_customer", True),
+        )
+
+        additional_data = instance.additional_data
+        additional_data["serializer_data"]["only_approved"] = only_approved
+        additional_data["serializer_data"]["transaction_subtype"] = transaction_subtype
+        additional_data["serializer_data"]["nnm_from"] = nnm_from
+        additional_data["serializer_data"]["creator"] = creator
+        additional_data["serializer_data"]["claimant"] = claimant
+        additional_data["serializer_data"]["in_charge_of_customer"] = in_charge_of_customer
+
+        additional_data["list_data"] = instance.get_handler().get_list_data(additional_data["serializer_data"])
+        validated_data["additional_data"] = additional_data
+
+        return super().update(instance, validated_data)
+
+    class Meta(KPIModelSerializer.Meta):
+        fields = (
+            *KPIModelSerializer.Meta.fields,
+            "transaction_subtype",
+            "nnm_from",
+            "creator",
+            "claimant",
+            "in_charge_of_customer",
+            "only_approved",
+        )
+
+
+class NetNewMoneyKPI(KPIHandler):
+    def get_name(self) -> str:
+        return "Net New Money"
+
+    def get_serializer(self) -> Type[Serializer]:
+        return NetNewMoneyKPISerializer
+
+    def annotate_parameters(self, queryset: QuerySet[KPI]) -> QuerySet[KPI]:
+        return queryset.annotate(
+            transaction_subtype=F("additional_data__serializer_data__transaction_subtype"),
+            nnm_from=F("additional_data__serializer_data__nnm_from"),
+            creator=F("additional_data__serializer_data__creator"),
+            claimant=F("additional_data__serializer_data__claimant"),
+            in_charge_of_customer=F("additional_data__serializer_data__in_charge_of_customer"),
+            only_approved=F("additional_data__serializer_data__only_approved"),
+        )
+
+    def get_list_data(self, serializer_data: dict) -> list[str]:
+        return [
+            f"Claim Area: {serializer_data['transaction_subtype']}",
+            f"NNM from: {serializer_data['nnm_from']}",
+            f"Creator: {serializer_data['creator']}",
+            f"Claimant: {serializer_data['claimant']}",
+            f"In charge of customer: {serializer_data['in_charge_of_customer']}",
+            f"Only Approved: {serializer_data['only_approved']}",
+        ]
+
+    def get_display_grid(self) -> list[list[str]]:
+        return [
+            ["nnm_from"] * 3,
+            ["only_approved"] * 3,
+            ["transaction_subtype"] * 3,
+            ["creator", "claimant", "in_charge_of_customer"],
+        ]
+
+    def evaluate(self, kpi: "KPI", evaluated_person, evaluation_date=None) -> int:
+        serializer_data = kpi.additional_data.get("serializer_data")
+        to_date = evaluation_date if evaluation_date else kpi.period.upper
+        claims = (
+            Claim.objects.exclude(status=Claim.Status.WITHDRAWN)
+            .filter(date__gte=kpi.period.lower, date__lte=to_date, account__isnull=False)
+            .annotate(
+                existing_client=Exists(Claim.objects.filter(date__lte=kpi.period.lower, account=OuterRef("account")))
+            )
+        )
+
+        if serializer_data.get("only_approved") is True:
+            claims = claims.filter(status=Claim.Status.APPROVED)
+
+        if (nnm_from := serializer_data.get("nnm_from")) and (nnm_from != "all"):
+            if nnm_from == "new_clients":
+                claims = claims.filter(existing_client=False)
+            elif nnm_from == "existing_clients":
+                claims = claims.filter(existing_client=True)
+
+        # TODO This introduced duplicates and can't be removed easily with distinct("id") because of the aggregation
+        accounts_ids = list(
+            Account.get_managed_accounts_for_entry(evaluated_person.entry_ptr).values_list("id", flat=True)
+        )
+        for employer in evaluated_person.employers.all():
+            accounts_ids.extend(list(Account.get_managed_accounts_for_entry(employer).values_list("id", flat=True)))
+        accounts = Account.objects.filter(id__in=accounts_ids)
+        claims = claims.filter(account__in=accounts)
+
+        return claims.annotate(
+            net_new_money=F("trade__price") * F("shares"),
+            fx_rate=CurrencyFXRates.get_fx_rates_subquery("date", currency="product__currency", lookup_expr="exact"),
+            net_new_money_usd=Coalesce(F("net_new_money") * F("fx_rate"), Decimal(0)),
+        ).aggregate(s=Sum("net_new_money"))["s"] or Decimal(0)

wbportfolio/models/llm/wbcrm/analyze_relationship.py

@@ -0,0 +1,58 @@
+import json
+from typing import TYPE_CHECKING
+
+from django.db.models import F, FloatField, Sum
+from django.db.models.functions import Cast, ExtractYear
+from langchain_core.messages import HumanMessage, SystemMessage
+from wbfdm.models import Instrument
+
+if TYPE_CHECKING:
+    from langchain_core.messages import BaseMessage
+    from wbcrm.models import Account
+
+
+def get_holding_prompt(account: "Account") -> list["BaseMessage"]:
+    from wbportfolio.models import Product
+    from wbportfolio.models.transactions.claim import Claim
+
+    products = (
+        Claim.get_valid_and_approved_claims(account=account)
+        .distinct("product")
+        .values_list("product", "product__isin")
+    )
+
+    performances = {}
+    for product_id, product_name in products:
+        performances[product_name] = Instrument.extract_annual_performance_df(
+            Product.objects.get(id=product_id).get_prices_df()
+        ).to_dict()
+
+    return [
+        SystemMessage(
+            "The following products are held by the account holder. Analyze their performances and check correlations between the holdings and their performances/interactions."
+        ),
+        HumanMessage(json.dumps(performances)),
+    ]
+
+
+def get_performances_prompt(account: "Account") -> list["BaseMessage"]:
+    from wbportfolio.models.transactions.claim import Claim
+
+    holdings = (
+        Claim.get_valid_and_approved_claims(account=account)
+        .annotate(year=ExtractYear("date"))
+        .values("year", "product")
+        .annotate(
+            sum_shares=Cast(Sum("shares"), FloatField()),
+            product_name=F("product__name"),
+            product_isin=F("product__isin"),
+        )
+        .values("product_name", "product_isin", "sum_shares", "year")
+    )
+
+    return [
+        SystemMessage(
+            "The following holdings (subscriptions/redemptions) have been found for this account. Please include this data in the analysis and check if there is any correlation between the holding data and the interactions."
+        ),
+        HumanMessage(json.dumps(list(holdings.order_by("year", "product")))),
+    ]

wbportfolio/static/wbportfolio/css/macro_review.css

@@ -0,0 +1,17 @@
+.page-header {
+  background-color: #051f2d;
+  text-align: center;
+  font-size: 30px;
+  color: #fff;
+  border-radius: 0;
+}
+
+strong {
+  color: #f25d47;
+  font-weight: 700;
+  white-space: nowrap;
+}
+
+.page-content {
+  padding: 0 30px;
+}

wbportfolio/static/wbportfolio/markdown/documentation/account_holding_reconciliation.md

@@ -0,0 +1,16 @@
+### Welcome to the Account Holding Reconciliation. Please confirm your holdings:
+
+* **Confirm Holdings**: Press the **'Agree'** button.
+* **Disagree with Holdings**: Adjust your holdings and press the **'Communicate Differences'** button. (This button will appear after adjustments are made.)
+
+### How to Adjust Your Holdings:
+
+* Select the **shares** or **nominal value** cell in the "Your Input" column.
+* Press **Enter**, adjust the value, and press **Enter** again.
+* Alternatively, right-click the cell and select **'Edit'** to adjust the value.
+
+### Additional Options:
+
+* **View all Subscriptions/Redemptions**: Press the **'Show Subscriptions/Redemptions'** button.
+* **Add a Subscription/Redemption**: Press the **'Add Subscription/Redemption'** button.
+* **Single Product Actions**: Right-click any row below to display all Subscriptions/Redemptions or add a new Subscription/Redemption for a specific product.

wbportfolio/static/wbportfolio/markdown/documentation/aggregate_asset_position_liquidity.md

@@ -0,0 +1,25 @@
+# Aggregate AssetPosition Liquidity Table View
+
+The purpose of this view is to observe how fast an aggregated asset position
+can be sold across all portfolios. We have two columns for two different dates.
+One column shows the velocity and the other one shows the relative percent of
+the total AuM (Asset under Management), "Days to Liquidate" and "Percent AUM"
+respectively.
+
+Some good things to know:
+
+- We use the mean volume for the last 50 days.
+
+- One third of the average volume for an asset position is
+  used to estimate the velocity. This number is subjective and attempts
+  to represent the number of trades that can be made.
+
+- If we have a value for more than 3 days to sell an asset position,
+  the latter will be displayed in yellow. If this value is greater than 5,
+  it will be in red.
+
+- We can use a filter that only displays asset positions that have a date
+  to liquidate greater than a given value for the Historic Date.
+
+- The "Compared Date" is used to compare the asset position with the Historic Date.
+Therefore, the values are not sorted for the last two columns.

wbportfolio/static/wbportfolio/markdown/documentation/company.md

@@ -0,0 +1,78 @@
+# Companies
+A list of every company saved in the database.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the company.
+
+### City:
+The city of the company's primary address. Hover over the name to display the full address.
+
+### Type:
+The company's type. Company types can be added, edited and deleted by managers under CRM > Administration > Company Types.
+
+### Tier:
+The company's tier. Tiers range from 1 to 5 and are automatically computed like this:
+_Company is of status client or TPM:_
+| Invested AUM / AUM  | Tier |
+| -------- | --------|
+| > 0.1 | Tier 1 |
+| 0.05 - 0.1 | Tier 2 |
+| 0.02 - 0.05 | Tier 3 |
+| 0.01 - 0.02 | Tier 4 |
+| default | Tier 5 |
+
+_Company is *not* of status client or TPM:_
+| AUM  | Tier |
+| -------- | --------|
+| > 10,000,000,000 $ | Tier 1 |
+| 5,000,000,000 \$ - 10,000,000,000 $ | Tier 2 |
+| 1,000,000,000 \$ - 5,000,000,000 $ | Tier 3 |
+| 500,000,000 \$ - 1,000,000,000 $ | Tier 4 |
+| default | Tier 5 |
+
+### Status:
+The company's status. Company statuses can be added, edited and deleted by managers under CRM > Administration > Customer Status.
+
+### AUM Invested:
+The company's assets under management managed by the main company.
+
+### AUM:
+Total assets under management for the company.
+
+### Potential:
+The potential reflects how much potential a company (regardless if client/propective) has. Formula: AUM * (Asset Allocation * Asset Allocation Max Investment) - Invested AUM. The field is populated automatically.
+
+### Primary Relationship Manager:
+The primary relationship manager of this company. Hover over the name to display further information about the person.
+
+### Last Activity:
+The name and end date of the company's last activity. Hover over it to display further information about the activity. Column can also be ordered by end date of the activity.
+
+### Activity Heat:
+A visual representation of the company's activeness. The data representation ranges from 0 to 1 which needs to be kept in mind to be able to apply a proper filter to the column.
+
+## Filters:
+
+### No Activity:
+Filter companies with no activity for x amount of time.
+
+### Companies' Employee:
+Display employers of the selected person.
+
+## Search Field:
+Typing in the search field allows to filter the companies by name.
+
+## Buttons:
+You can right-click each row to reveal three buttons:
+
+### Activities:
+Displays activities for the row's company.
+
+### Employees:
+Displays a list of the company's employees.
+
+### Relationship Managers:
+Displays all relationship managers of the row's company.

wbportfolio/static/wbportfolio/markdown/documentation/earnings_instrument.md

@@ -0,0 +1,14 @@
+# Earnings Analysis
+
+Consensus $ EPS
+
+## Filters
+
+A set of filters that control the analysis is available:
+
+1. **Analysis**: EPS ($)
+    - **$ EPS  [default view]**: By default shows an aggregated $ EPS (weighted).
+
+2. **Period**: Common periods (TTM, FTM, FY+1, FY+2) are available with **FTW** set by default.
+
+3. **Show related**: Adds lines for all specified peers if available

wbportfolio/static/wbportfolio/markdown/documentation/financial_analysis_instrument_ratios.md

@@ -0,0 +1,94 @@
+# Relative valuation
+
+Classic and commonly used relative ratios PE, PEG, PS, PFCF, EV-EBITDA
+Additional comparative metrics: growth (EPS, Sales, FCF), EV, Market Cap
+
+## Filters
+
+A set of filter is available:
+1. **Output**: Chart, Table (Last Value), Table (Time-series)
+    - **Chart [default view]**: By default shows all ratios for the instrument in question in one figure with PEG on a secondary/right axis.
+    - **Table (Last Value)**: By default shows the last available  value for all ratios for the instrument in question in one table.
+    - **Table (Time-series)**: Shows all available values for all ratios for the instrument in question in one table.
+
+2. **Period**: Common periods (TTM, FTW, FY+1, FY+2) are available with **FTW** set by default.
+
+3. **Versus related (not available in the Time-series view):**
+    - if the view "**Table (Last Value)**" is set, then all available related instruments (peers, partners, suppliers, etc.) will be shown in the same table, including Mean and Median values.
+    - if the view "**Chart**" is set, then all available related instruments (peers, partners, suppliers, etc.) will be shown in the same chart. Additionally, the user may choose which variables to show on X,Y,and Bubble Size axis. Median line may be disactivated, if desired.
+
+4. **Draw ranges**: if the view "**Chart**" is set, then each ratio will be shown on a separate subplot with historic min-max ranges shown with dashed lines.
+
+5. **Range type**: if the view "**Chart**" is set and "**Draw ranges**" is activated, then a user may choose the type of "min-max" range: Min-Max (entire period) or Rolling.
+    - **"Min-Max (entire period)"** looks for the min and max values for each ratio across the entire period in questions and sets it for the entire graph.
+    - **"Rolling"** looks for the min and max values for each ratio across the "Rolling Period" specified in a separate filter.
+
+6. **Rolling period**: works with "**Range type**" filter if the view "**Chart**" is set and "**Draw ranges**" is activated.
+
+7. **Clean data** (more "treatment"): significant and heavy data cleaning will be applied to all variables. For **each** series:
+    - All raw input data is forward and then backward filled.
+    - All empty rows are deleted and remaining blanks for all variables are filled by linear interpolation.
+    - Ratios are then normally calculated.
+    - The resulting series are cleaned for outliers (values in the top and bottom 5% are deleted).
+    - All negative (incl. EV/S) and NaN values are set to Null (deleted as "non-meaningful").
+    - All values above a certain threshold (by default 100) are deleted. **Exceptions** are:
+        - PEG above 15
+        - PS above 40
+    - The remaining series are forward and backward filled to clean missing values for smoother series.
+    - All series are smoothed (3-day simple moving average). The **PEG** series is smoothed differently (10-day simple moving average).
+
+8. **X-Axis**: works if the view "**Chart**" is set and "**Versus related**" is activated. Controls the variable shown on the x-axis.
+
+9. **Y-Axis**: works if the view "**Chart**" is set and "**Versus related**" is activated. Controls the variable shown on the y-axis.
+
+10. **Z-Axis (bubble size)**: works if the view "**Chart**" is set and "**Versus related**" is activated. Controls the variable shown on the z-axis/bubble size.
+
+11. **Median**: works if the view "**Chart**" is set and "**Versus related**" is activated. Calculates the median for **X-Axis** and **Y-Axis** variables across the entire period range.
+
+## Formulas
+
+#### FY+1 and FY+2
+
+$$
+Ratio_{t} = Price_{t} / Ratio\: Item_{t}
+$$
+
+$
+where \\
+$
+$$
+t    =  day \\
+$$
+$
+Ratio\: Item =
+$
+$$
+EPS = Daily\: Consensus\: Net\: Profit\: Forecast / Number\:of\:shares\\
+or \\
+Revenue\: per\: share = Daily\: Consensus\: Revenue\: Forecast / Number\:of\:shares\\
+or \\
+EBITDA\: per\: share = Daily\: Consensus\: EBITDA\; Forecast / Number\:of\:shares\\
+or \\
+FCF = Daily\: Consensus\: FreeCashFlow\; Forecast / Number\:of\:shares\\
+$$
+
+#### Trailing Twelve Month (TTM) and Next Twelve Month (NTM) *also known as Forward Twelve Months (FTM)*
+\
+$
+Ratio\: Item =
+$
+$$
+EPS = Daily\: EPS\: TTM\: \\
+or \\
+Revenue\: or\: EBITDA\: or\: FCF\: per\: share = Interpolated\: between\: consensus\: FY+2\:,\: FY+1 \\
+Revenue\: or\: EBITDA\: or\: FCF\:per\: share =Interpolated\: between\: FY+1\:(current)\:,\: FY0\:(last)\:,\: FY-1\:(previous) \\
+$$
+
+#### Trailing Twelve Month (TTM) and Next Twelve Month (NTM) *also known as Forward Twelve Months (FTM)*
+\
+$
+DailyPEG_{fy+1} = Price / EPS_{fy+1} / Growth_{fy+1\: vs\: fy0} \\
+DailyPEG_{fy+2} = Price / EPS_{fy+2} / Growth_{geoavg(fy+2\: vs\: fy1,\:fy+1\: vs\: fy0)} \\
+DailyPEG_{NTM} = Price / EPS_{NTM} / Growth_{ntm\: vs\: ttm} \\
+DailyPEG_{TTM} = Price / EPS_{TTM} / Growth_{ttm\: vs\: ttm_{t-1}} \\
+$