Docs update, more fixture files

open-risk · Mar 15, 2022 · 2552bb2 · 2552bb2
1 parent 5580b10
commit 2552bb2
Show file tree

Hide file tree

Showing 41 changed files with 635,088 additions and 144 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 [![Documentation Status](https://readthedocs.org/projects/equinox-server/badge/?version=latest)](https://equinox-server.readthedocs.io/en/latest/?badge=latest)
 
 # Equinox Overview
-![Equinox Logo](/docs/source/equinox-logo.png) Equinox is an open source platform that supports the holistic risk management and reporting of major sustainable finance projects (the financing of projects with material physical footprint) such as project finance.
+![Equinox Logo](docs/source/equinox-logo.png) Equinox is an open source platform for sustainable portfolio management. It supports the holistic risk management and reporting of sustainable finance projects in accordance with industry standards.
 
-## The Challenge of Project Finance and Sustainability
+## The Challenge of Sustainable Finance
 Sustainability (understood both in environmental and social terms) is a serious and ongoing issue that affects all economies. Developing tools and methodologies that improve the ability of all stakeholders to assess and report risks is thus an important objective
 
 ## What exactly is Equinox?
@@ -20,10 +20,26 @@ The initial functionality of Equinox focuses on integrating the following concep
 * Equator Principles for Project Finance
 * GHG Accounting Protocol for Projects
 
+## Screenshots
+
+The landing page of a working equinox instance:
+
+![Landing Page](docs/source/screenshots/landing.png)
+
+
+To get anything done we need to login! (admin/admin would be the credentials in a local demo instance)
+
+![Login Page](docs/source/screenshots/login.png)
+
+Once you login successfully you'd be greeted by the admin area
+
+![Admin Page](docs/source/screenshots/admin.png)
+
+The admin is our main workbench
 
 ## Credits
-* Django
-* Jazzmin
-* European Banking Authority
-* Partnership for Carbon Accounting Financials  
-* Equator Principles
+* The Python and Django ecosystems and the many powerful software components (Geodjango, Jazzmin, ... full list coming) 
+* The GHG Protocol
+* The European Banking Authority
+* The Partnership for Carbon Accounting Financials  
+* The Equator Principles Alliance
diff --git a/docs/source/Asset.rst b/docs/source/Asset.rst
@@ -1,13 +1,19 @@
 Asset
 ------------------------------
-The Asset model holds asset specific data for each real asset, facility (plant, infrastructure etc) that is part of a Project (which may or may not be financed)
+The Asset model holds asset specific data for each real asset, facility (plant, infrastructure etc) that is part of a **Project* (which may or may not be financed)
 
 The assumption is that an Asset participates in only one Project at a time (if linked to a project object)
 
+A special type of Asset is a **Building** (whether used for residential or commercial purposes).
+
+.. note::  To further classify assets, the EBA Loan Asset Classes are used for correspondence, but those are *financial asset classes*.
 
 .. automodule:: portfolio.Asset
    :members:
    :undoc-members:
    :noindex:
 
-   .. automethod:: portfolio.Asset.Asset
+   .. automethod:: portfolio.Asset.ProjectAsset
+
+
+   .. automethod:: portfolio.Asset.Building
diff --git a/docs/source/Borrower.rst b/docs/source/Borrower.rst
@@ -0,0 +1,9 @@
+Contractor
+------------------------------
+
+.. automodule:: portfolio.Borrower
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.Borrower.Borrower
diff --git a/docs/source/EmissionsSource.rst b/docs/source/EmissionsSource.rst
@@ -0,0 +1,18 @@
+Emissions Source
+------------------------------
+Emissions Source models hold granular activity and emissions type data that characterize and quantify the emissions of an Asset.
+
+An asset may involve multiple emissions sources. There are several submodels, adapted to different portfolio management use cases
+
+.. automodule:: portfolio.EmissionsSource
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.EmissionsSource.EmissionsSource
+
+
+   .. automethod:: portfolio.EmissionsSource.GPCEmissionsSource
+
+
+   .. automethod:: portfolio.EmissionsSource.BuildingEmissionsSource
diff --git a/docs/source/GHG_Project.rst b/docs/source/GHG_Project.rst
diff --git a/docs/source/GHG_Project_Workflow.rst b/docs/source/GHG_Project_Workflow.rst
@@ -0,0 +1,7 @@
+GHG Project Protocol Workflow
+------------------------------------
+
+
+The following steps replicate the GHG Project workflow
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
diff --git a/docs/source/Mortgage.rst b/docs/source/Mortgage.rst
@@ -0,0 +1,9 @@
+Mortgage
+------------------------------
+
+.. automodule:: portfolio.Mortgage
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.Mortgage.Mortgage
diff --git a/docs/source/PCAF.rst b/docs/source/PCAF.rst
@@ -3,11 +3,11 @@ The PCAF Workflows
 
 The Partnership for Carbon Accounting Financials proposed methodologies (PCAF (2020), The Global GHG Accounting and Reporting Standard for the Financial Industry.) for attributing GHG Emissions to diverse financial contracts.
 
-The workflows for PCAF methodologies implemented in Equinox are documented below. For the methodologies themselves consult PCAF documentation or the `Open Risk Manual Entries <https://www.openriskmanual.org/wiki/PCAF_Methodology>`_
+The workflows for PCAF methodologies implemented in Equinox are documented below. For the methodologies themselves consult the corresponding PCAF documentation or the `Open Risk Manual Entries <https://www.openriskmanual.org/wiki/PCAF_Methodology>`_
 
 .. toctree::
    :maxdepth: 1
    :caption: Methodology List:
 
-   PCAF_Mortgages
-   PCAF_ProjectFinance
+   PCAF_Mortgages_Workflow
+   PCAF_ProjectFinance_Workflow
diff --git a/docs/source/PCAF_Mortgages.rst → docs/source/PCAF_Mortgages_Workflow.rst b/docs/source/PCAF_Mortgages.rst → docs/source/PCAF_Mortgages_Workflow.rst
diff --git a/docs/source/PCAF_ProjectFinance.rst → docs/source/PCAF_ProjectFinance_Workflow.rst b/docs/source/PCAF_ProjectFinance.rst → docs/source/PCAF_ProjectFinance_Workflow.rst
diff --git a/docs/source/Portfolios.rst b/docs/source/Portfolios.rst
@@ -0,0 +1,18 @@
+Portfolios
+------------------------------
+
+.. automodule:: portfolio.Portfolios
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.Portfolios.Portfolio
+
+
+   .. automethod:: portfolio.Portfolios.PortfolioSnapshot
+
+
+   .. automethod:: portfolio.Portfolios.PortfolioData
+
+
+   .. automethod:: portfolio.Portfolios.LimitStructure
diff --git a/docs/source/PrimaryEffect.rst b/docs/source/PrimaryEffect.rst
@@ -0,0 +1,9 @@
+Operator
+------------------------------
+
+.. automodule:: portfolio.PrimaryEffect
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.PrimaryEffect.PrimaryEffect
diff --git a/docs/source/Project.rst b/docs/source/Project.rst
@@ -0,0 +1,9 @@
+Project
+------------------------------
+
+.. automodule:: portfolio.Project
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.Project.Project
diff --git a/docs/source/ProjectActivity.rst b/docs/source/ProjectActivity.rst
@@ -0,0 +1,9 @@
+Operator
+------------------------------
+
+.. automodule:: portfolio.ProjectActivity
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.ProjectActivity.ProjectActivity
diff --git a/docs/source/SecondaryEffect.rst b/docs/source/SecondaryEffect.rst
@@ -0,0 +1,9 @@
+Operator
+------------------------------
+
+.. automodule:: portfolio.SecondaryEffect
+   :members:
+   :undoc-members:
+   :noindex:
+
+   .. automethod:: portfolio.SecondaryEffect.SecondaryEffect
diff --git a/docs/source/description.rst b/docs/source/description.rst
@@ -1,44 +1,47 @@
-The equinox platform
-=====================
-**equinox** is a Python / Django powered portfolio management platform that allows the collection and reporting of project finance risk and sustainability characteristics
+The equinox platform at a glance
+============================================
+**equinox** is a Python / Django powered sustainable portfolio management platform that allows the collection and reporting of sustainable finance risk and sustainability characteristics
 
 
 Architecture
 -------------
 
-* At the core of equinox are a number of data models that capture information about the different entities and concepts involved in Sustainable Finance. These data models follow a logical pattern that is independent of any of the reference standards or eventual applications that are being implemented.
-* Functionality is delivered via a number of apps that process user inputs and portfolio data and deliver analyses and reports
-
+- At the core of equinox are a number of **data models** that capture information about the different entities and concepts involved in Sustainable Finance and more specifically Portfolio Management. These data models follow a logical pattern that is independent of any of the reference standards or eventual applications that are being implemented.
+- Functionality is delivered via a number of **apps** that process user inputs and portfolio data and deliver analyses and reports
 
 Data Layer
 ---------------
-The data layer can be segmented into two major categories: The Physical Layer that holds information about physical aspects of assets, activities etc. and the "socioeconomic" layer that holds information about entities, economic and financial aspects etc.
-
-
-Physical Layer
-~~~~~~~~~~~~~~~~~~
-* Project is the core object. It belongs to a Project Category
-* One or More Assets are major real items linked to the Project.
-* Primary Effect is the GHG impact of a Project Activity
-* Secondary Effect is the GHG impact of a Project Activity
-* Project Activity is a specific Sustainability impact (eg GHG reduction) of a Project
-
-Socioeconomic Layer
-~~~~~~~~~~~~~~~~~~~~~
-* Project Company is a Legal Entity that finances a Project
-* Contractors are Entities that are involved in delivering under contract to the Project Company
-* Operators are Entities that are involved in operating under contract to the Project Company
-* Sponsors are Entities that are involved in commissioning, guaranteeing or providing equity to the Project Company
-* Stakeholders are other entities that are impacted or impacting by the Project Company
-* Revenue focuses specifically on the business model of a Project Company
-* A Loan is a borrowing made by a Project Company
-* Swap is an example of additional contract by the Project Company
-* Scorecard collects relevant data to support the risk analysis of a Project Company
+The data layer can be segmented into two major categories:
+- The *Physical Data Layer* that holds information about physical aspects of assets, activities etc. and
+- The *Socioeconomic Data Layer* that holds information about entities, economic and financial aspects etc.
+
+
+Physical Data Layer
+~~~~~~~~~~~~~~~~~~~~
+- Assets are the core objects with environmental impact (emissions)
+- Project is the core portfolio management object. It belongs to a Project Category
+- One or More Assets may ne linked to a Project.
+- Primary Effect is the GHG impact of a Project Activity
+- Secondary Effect is the GHG impact of a Project Activity
+- Project Activity is a specific Sustainability impact (eg GHG reduction) of a Project
+
+Socioeconomic Data Layer
+~~~~~~~~~~~~~~~~~~~~~~~~~
+- Project Company is a Legal Entity that finances a Project
+- Borrower is a Legal Counterparty to a Loan contract (may be natural person or corporate entity)
+- Contractors are Entities that are involved in delivering under contract to the Project Company
+- Operators are Entities that are involved in operating under contract to the Project Company
+- Sponsors are Entities that are involved in commissioning, guaranteeing or providing equity to the Project Company
+- Stakeholders are other entities that are impacted or impacting by the Project Company
+- Revenue focuses specifically on the business model of a Project Company
+- A Loan is a borrowing made by a Project Company
+- Swap is an example of additional contract by the Project Company
+- Scorecard collects relevant data to support the risk analysis of a Project Company
 
 Application Layer
 ------------------
-The application layer help the user extract useful information from the database and perform the required analyses and reports
+The application layer helps users extract useful information from the database and perform the required analyses and reports
 
-* Asset Manager
-* Risk Analysis
-* Results Explorer
+- Asset Manager
+- Risk Analysis
+- Results Explorer
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,12 +8,12 @@ equinox Documentation
   :alt: equinox Logo
   :align: left
 
-**Equinox** is an open source platform for collecting and reporting risk and sustainability information about project finance. Equinox implements and integrates a number of regulatory or industry standards that cover the space of GHG emissions attribution and reporting and ESG risk analysis.
+**Equinox** is an open source platform for sustainable portfolio management. Equinox implements and integrates a number of regulatory or industry standards that cover the space of GHG emissions attribution and reporting and ESG risk analysis.
 
 The full list of implemented standards is in :ref:`References`
 
 
-.. note:: The equinox project is still in its early phases and is not yet suitable for deployment.
+.. note:: The equinox project is still in its development phase and is not yet suitable for production deployments.
 
 
 Overview
@@ -24,9 +24,9 @@ Overview
 * Development Website: `Github <https://github.com/open-risk/equinox>`_
 * Online Code Documentation: `Read The Docs <https://equinox-server.readthedocs.io/en/latest/>`_
 * Project Discussion: `Open Risk Commons <https://www.openriskcommons.org/c/sustainable-finance>`_
-* Docker Image: Coming
-* Training: Coming: `Open Risk Academy <https://www.openriskacademy.com/>`_
-
+* Docker Image: `Docker Hub <https://hub.docker.com/repository/docker/openrisk/equinox>`_
+* Training: `Open Risk Academy <https://www.openriskacademy.com/>`_
+* Showcase: `Equinox Point <https://www.equinoxpoint.org/>`_
 
 .. toctree::
    :maxdepth: 2
@@ -57,7 +57,7 @@ Overview
    getting_started
    pages
    reference_data
-   GHG_Project
+   GHG_Project_Workflow
    PCAF
    CIRIS
    EBA_Scorecard

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -2,19 +2,33 @@
 
 Equinox Data Models
 ==============================
-The following pages document the Equinox data models. Each data model is implemented in a separate file TABLE_NAME.py in the portfolio directory.
+The following pages document the Equinox data models. In general each data model is implemented in a separate file TABLE_NAME.py in the portfolio directory.
+
+.. note:: Variations of data models might be implemented together in the same file.
+
+Portfolio Data Models
+----------------------------
 
 .. toctree::
    :maxdepth: 4
 
    Asset
+   EmissionsSource
+   Project
    ProjectCompany
+   ProjectActivity
+   PrimaryEffect
+   SecondaryEffect
+   Borrower
    Loan
+   Mortgage
+   Portfolios
    Contractor
    Operator
    Swap
    Stakeholders
    Sponsors
    Revenue
 
-
+Reference Data Models
+-----------------------------