update doc url

README.md

@@ -29,7 +29,7 @@ The functionality of Equinox focuses on integrating the following concepts:
 * The European Banking Authority's Criteria for Credit Risk Assessment of Project Finance under the Standardized approach for Specialized Lending
 
 ## Find out more:
-- For [User Documentation](https://www.openriskmanagement.com/equinox/)
+- For [User Documentation](https://www.openriskmanagement.com/documentation/equinox/)
 - For [Technical Documentation](https://equinox-server.readthedocs.io/en/latest/)
 - 💬 [Discussion at the Open Risk Commons](https://www.openriskcommons.org/c/equinox/27)
 - For broader sustainable finance knowledge base, consult the [Open Risk Manual](https://www.openriskmanual.org/wiki/Category:Sustainable_Finance)
@@ -42,11 +42,11 @@ The landing page of a working equinox instance:
 
 ![Landing Page](docs/source/landing.png)
 
-To get anything done we need to login! (admin/admin would be the credentials in a local demo instance)
+To get anything done we need to log in! (admin/admin would be the credentials in a local demo instance)
 
 ![Login Page](docs/source/login.png)
 
-Once you login successfully you'd be greeted by the admin area
+Once you log in successfully you'd be greeted by the admin area
 
 ![Admin Page](docs/source/admin.png)
 

docs/source/description.rst

@@ -1,9 +1,9 @@
-The equinox platform at a glance
+The Equinox platform at a glance
 ============================================
 
-**equinox** is a Python / Django powered sustainable portfolio management platform. It allows the collection and reporting of information relating to sustainable finance and more broadly any portfolio of financial contracts or instruments that has material sustainability related characteristics
+**Equinox** is a Python / Django powered _sustainable portfolio management_ platform. It allows the collection and reporting of information relating to sustainable finance and more broadly any portfolio of financial contracts or instruments that has material sustainability related characteristics
 
-This documentation focuses on technical (software, installation, devops) characteristics of the equinox platform. Documentation of the user perspective (Functionality, workflows etc is provided `here <https://www.openriskmanagement.com/equinox>`_
+This documentation focuses on technical (software, installation, devops) characteristics of the equinox platform. Documentation of the user perspective (Functionality, workflows etc is provided `here <https://www.openriskmanagement.com/documentation/equinox>`_
 
 Architecture
 -------------
@@ -19,7 +19,6 @@ The equinox data layer can be segmented into several major categories:
 - The *Socioeconomic Data Layer* that holds information about economic agents and their economic and financial profiles. This too concerns information external to the portfolio manager.
 - The *Portfolio Management Layer* that overlays internal portfolio management information about sustainability scenarios, portfolio constraints, limits and targets etc.
 
-
 Lets look at those layers in some more detail. Each one is implemented as as set of specialized data models, with corresponding database schema.
 
 Physical Data Layer

equinox/settings.py

@@ -67,6 +67,7 @@
     'markdownfield',
     'leaflet',
     'django_countries',
+    'pwa',
     'start',
     'reference',
     'portfolio',
@@ -363,3 +364,48 @@
         "success": "btn-outline-success"
     }
 }
+
+PWA_APP_NAME = "Equinox PWA App"
+PWA_APP_DESCRIPTION = "Equinox PWA Apps"
+PWA_APP_THEME_COLOR = "#007bff"
+PWA_APP_BACKGROUND_COLOR = "#ffffff"
+PWA_APP_DISPLAY = 'standalone'
+PWA_APP_SCOPE = '/'
+PWA_APP_ORIENTATION = 'any'
+PWA_APP_START_URL = '/'
+PWA_APP_STATUS_BAR_COLOR = 'default'
+PWA_APP_ICONS = [
+    {
+        'src': '/static/images/icon.png',
+        'sizes': '160x160'
+    }
+]
+PWA_APP_ICONS_APPLE = [
+    {
+        'src': '/static/images/apple-icon.png',
+        'sizes': '160x160'
+    }
+]
+# PWA_SERVICE_WORKER_PATH = os.path.join(BASE_DIR, 'static/start/js', 'serviceworker.js')
+PWA_APP_SPLASH_SCREEN = [
+    {
+        'src': '/static/images/icons/splash-640x1136.png',
+        'media': '(device-width: 320px) and (device-height: 568px) and (-webkit-device-pixel-ratio: 2)'
+    }
+]
+PWA_APP_DIR = 'ltr'
+PWA_APP_LANG = 'en-US'
+PWA_APP_SHORTCUTS = [
+    {
+        'name': 'Shortcut',
+        'url': '/target',
+        'description': 'Shortcut to a page in my application'
+    }
+]
+PWA_APP_SCREENSHOTS = [
+    {
+      'src': '/static/images/icons/splash-750x1334.png',
+      'sizes': '750x1334',
+      "type": "image/png"
+    }
+]

equinox/urls.py

@@ -28,6 +28,8 @@
 from drf_yasg import openapi
 from drf_yasg.views import get_schema_view
 from rest_framework import permissions
+from pwa import views as pwa_views
+from django.views.decorators.cache import cache_page
 
 from . import views, settings
 
@@ -46,6 +48,7 @@
 
 urlpatterns = [
                   path('', include('start.urls')),  # Equinox Start Page URLS
+                  path('offline/', cache_page(settings.PWA_APP_NAME)(pwa_views.offline)),
                   path('reporting/', include('reporting.urls')),  # Results Explorer URLS
                   path('policy/', include('policy.urls')),  # Results Explorer URLS
                   path('reference/', include('reference.urls')),  # Results Explorer URLS
@@ -54,7 +57,7 @@
                   path('admin/', admin.site.urls),  # Equinox Admin URL's
                   path(r'api/', views.api_root, name='api_root'),  # API root
                   path(r'api/portfolio_data/', include(('portfolio.urls', 'portfolio'), namespace='portfolio')),
-                  # Portfolio data API
+                  # Portfolio Data API
               ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 
 # This is the optional debug toolbar

requirements.txt

@@ -1,28 +1,32 @@
-Django
-djangorestframework
+Django~=5.0.6
+djangorestframework~=3.15.1
 drf-yasg
-numpy
-pandas
-scipy
+numpy~=1.26.4
+pandas~=2.2.2
+scipy~=1.13.0
 jsonfield
-Markdown
+Markdown~=3.6
 Pillow
 django-leaflet
 django-jazzmin
 django-json-widget
 django-markdownfield
-django-treebeard
+django-treebeard~=4.7.1
 django-import-export
 django-prettyjson
 django-countries
+django-pwa
 django-extensions
 django-htmx
-django-debug-toolbar
+django-debug-toolbar~=4.3.0
 psycopg2
 Sphinx
 sphinx-rtd-theme
-selenium
+selenium~=4.18.1
 behave-django
-pytest
+pytest~=8.0.1
 pytest-bdd
-coverage
+coverage
+requests~=2.31.0
+behave~=1.2.6
+setuptools~=69.5.1

risk/Scorecard.py

@@ -28,7 +28,6 @@ class Scorecard(models.Model):
     """
     The Scorecard data model holds data for defined scorecards. The current implementation is a Credit Scorecard of the ProjectCompany
 
-
     """
 
     scorecard_identifier = models.CharField(max_length=80, blank=True, null=True,

risk/models.py

@@ -18,7 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-
 """
 The main Risk models are defined in individual files for readability
 Use models.py for any additional / auxiliary models