Version 0.2.0

DEVELOPING.md

@@ -253,6 +253,12 @@ docker run -e ORACLE_RANDOM_PASSWORD=true -e APP_USER=ixmp4_test -e APP_USER_PAS
 please note that you'll have to wait for a few seconds for the databases to be up and
 running.
 
+The `tests/docker-compose.yml` file might help you accomplish all of this with a single command for your convenience.
+
+```console
+docker-compose -f tests/docker-compose.yml up
+```
+
 ### Profiling
 
 Some tests will output profiler information to the `.profiles/` directory (using the `profiled` fixture). You can analyze these using `snakeviz`. For example:

Dockerfile

@@ -18,13 +18,13 @@ ENV \
     PIP_DISABLE_PIP_VERSION_CHECK=on \
     PIP_DEFAULT_TIMEOUT=100 
 
-RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python
+RUN pip install poetry
 
 ENV PATH="$POETRY_HOME/bin:$PATH"
 
 RUN poetry config virtualenvs.create false
 
-ADD . /opt/ixmp4
+COPY . /opt/ixmp4
 
 WORKDIR /opt/ixmp4
 

doc/source/conf.py

@@ -62,3 +62,13 @@
     "python": ("https://docs.python.org/3", None),
     "pyam": ("https://pyam-iamc.readthedocs.io/en/stable/", None),
 }
+
+# -- Prolog for all rst files ------------------------------------------------
+
+rst_prolog = """
+
+.. |br| raw:: html
+
+    <br>
+
+"""

doc/source/data-model.rst

@@ -1,12 +1,12 @@
-The **ixmp4** Data Model
+The **ixmp4** data model
 ========================
 
 The **ixmp4** package is a data warehouse for scenario data related to numerical modeling
 of climate policy, energy systems transition and sustainable development.
 
 This page is based on the section "The pyam data model" :cite:p:`Huppmann:2021:pyam-v1.0`.
 
-A Scenario Run
+A scenario run
 --------------
 
 An ixmp4 database contains data for "scenario runs", which can be one of the following:
@@ -28,7 +28,7 @@ A scenario run is identified by the following *index* attributes:
 
 A scenario run can have the data types shown below.
 
-The IAMC Timeseries Data Format
+The IAMC timeseries data format
 -------------------------------
 
 .. figure:: _static/iamc-logo.png
@@ -59,7 +59,7 @@ following the IAMC format from the Horizon 2020 `CD-LINKS`_ project.
 
 .. _`CD-LINKS`: https://www.cd-links.org
 
-Supported Time Domains
+Supported time domains
 ^^^^^^^^^^^^^^^^^^^^^^
 
 The implementation of the IAMC-format timeseries data format in **ixmp4** supports
@@ -80,7 +80,7 @@ A **run** can simultaneously have timeseries data for all temporal domains.
      of a :class:`pyam.IamDataFrame`.
    | Read the docs for the `pyam 'data' data model <https://pyam-iamc.readthedocs.io/en/stable/data.html#scenario-timeseries-data-data>`_.
 
-Meta Indicators
+Meta indicators
 ---------------
 
 Meta indicators are intended for categorisation and quantitative indicators

doc/source/index.rst

@@ -20,7 +20,7 @@ Overview
 The **ixmp4** package is a data warehouse for high-powered scenario analysis
 in the domain of integrated assessment of climate change and energy systems modeling.
 
-Table of Contents
+Table of contents
 -----------------
 
 .. toctree::
@@ -51,11 +51,11 @@ Funding acknowledgement
 
 .. figure:: _static/ariadne-bmbf-logo.png
    :align: left
-   :height: 80px
+   :height: 90px
 
 The development of the **ixmp4** package was funded from the EU Horizon 2020 projects
 `openENTRANCE <https://openentrance.eu>`_ and `ECEMF <https://ecemf.eu>`_
-as well as the BMBF Kopernikus project `ARIADNE <https://ariadneprojekt.de>`_
+as well as the BMBF Kopernikus project `ARIADNE <https://ariadneprojekt.de>`_ |br|
 (FKZ 03SFK5A by the German Federal Ministry of Education and Research).
 
 .. figure:: _static/EU-logo-300x201.jpg

docker/docker-compose.yml

@@ -3,7 +3,7 @@ version: "3"
 services:
   ixmp4_server:
     restart: always
-    image: ene-docker.iiasa.ac.at/ixmp4-server:latest
+    image: ene-docker.iiasa.ac.at/ixmp4-server:dev
     volumes:
       - ./run:/opt/ixmp4/run
     env_file:

docker/docker.env

@@ -1,3 +1,8 @@
 IXMP4_MODE=development
 IXMP4_DIR=/opt/ixmp4/run/ixmp
+IXMP4_SERVER_DIR=/opt/ixmp4/run
 IXMP4_SECRET_HS256=secretkey
+IXMP4_MANAGER_URL=https://api.dev.manager.ece.iiasa.ac.at/v1/
+NUM_WORKERS=2
+NUM_WORKERS=2
+

ixmp4/__init__.py

@@ -1,4 +1,5 @@
 # flake8: noqa
+import importlib.metadata
 
 from ixmp4.core import (
     Platform as Platform,
@@ -19,4 +20,4 @@
 
 from ixmp4.data.abstract import DataPoint as DataPoint
 
-__version__ = "0.1.0"
+__version__ = importlib.metadata.version("ixmp4")

ixmp4/cli/__init__.py

@@ -58,6 +58,14 @@ def login(
         )
 
 
+@app.command()
+def logout():
+    if typer.confirm(
+        "Are you sure you want to log out and delete locally saved credentials?"
+    ):
+        settings.credentials.clear("default")
+
+
 try:
     import pytest
 

ixmp4/cli/server.py

@@ -6,6 +6,7 @@
 
 from fastapi.openapi.utils import get_openapi
 from ixmp4.server import v1
+from ixmp4.conf import settings
 
 from . import utils
 
@@ -24,8 +25,14 @@ def start(
     ),
 ) -> None:
     """Starts the ixmp4 web api."""
-
-    uvicorn.run("ixmp4.server:app", host=host, port=port, reload=True)
+    reload = settings.mode != "production"
+    uvicorn.run(
+        "ixmp4.server:app",
+        host=host,
+        port=port,
+        reload=reload,
+        log_config="ixmp4/conf/logging/server.conf",
+    )
 
 
 @app.command()

ixmp4/conf/__init__.py

@@ -1,81 +1,5 @@
 from dotenv import load_dotenv
-from pathlib import Path
-
-from pydantic import BaseSettings, Field, validator, HttpUrl, Extra
-
-from ixmp4.core.exceptions import InvalidCredentials
-from .credentials import Credentials
-from .toml import TomlConfig
-from .manager import ManagerConfig
-from .auth import ManagerAuth
-from .user import local_user
-from .base import PlatformInfo as PlatformInfo
-
-
-class Settings(BaseSettings):
-    mode: str = "production"
-    storage_directory: Path = Field("~/.local/share/ixmp4/", env="ixmp4_dir")
-    secret_hs256: str = "default_secret_hs256"
-    migration_db_uri: str = "sqlite:///./run/db.sqlite"
-    manager_url: HttpUrl = Field("https://api.manager.ece.iiasa.ac.at/v1")
-
-    class Config:
-        env_prefix = "ixmp4_"
-        extra = Extra.allow
-
-    def __init__(self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-
-        self.storage_directory.mkdir(parents=True, exist_ok=True)
-
-        database_dir = self.storage_directory / "databases"
-        database_dir.mkdir(exist_ok=True)
-        self.load_credentials()
-        self.load_manager_config()
-        self.load_toml_config()
-
-    def load_credentials(self):
-        credentials_config = self.storage_directory / "credentials.toml"
-        credentials_config.touch()
-        self.credentials = Credentials(credentials_config)
-
-        self.default_credentials = None
-        self.default_auth = None
-        try:
-            self.default_credentials = self.credentials.get("default")
-        except KeyError:
-            # TODO: WARNING: No default credentials provided.
-            pass
-
-        if self.default_credentials is not None:
-            try:
-                username, password = self.default_credentials
-                self.default_auth = ManagerAuth(username, password, self.manager_url)
-            except InvalidCredentials:
-                # TODO: WARNING: Default credentials invalid.
-                pass
-
-    def load_manager_config(self):
-        self.manager = None
-        if self.default_auth is not None:
-            self.manager = ManagerConfig(
-                self.manager_url, self.default_auth, remote=True
-            )
-
-    def load_toml_config(self):
-        if self.default_auth is not None:
-            toml_user = self.default_auth.get_user()
-        else:
-            toml_user = local_user
-        toml_config = self.storage_directory / "platforms.toml"
-        toml_config.touch()
-        self.toml = TomlConfig(toml_config, toml_user)
-
-    @validator("storage_directory")
-    def expand_user(cls, v):
-        # translate ~/asdf into /home/user/asdf
-        return Path.expanduser(v)
-
+from ixmp4.conf.settings import Settings
 
 load_dotenv()
 # strict typechecking fails due to a bug

ixmp4/conf/auth.py

@@ -1,3 +1,4 @@
+import logging
 from uuid import uuid4
 from datetime import datetime, timedelta
 
@@ -6,7 +7,9 @@
 
 from ixmp4.core.exceptions import InvalidCredentials, IxmpError
 
-from .user import User
+from .user import User, anonymous_user
+
+logger = logging.getLogger(__name__)
 
 
 class BaseAuth(object):
@@ -23,11 +26,11 @@ def get_user(self) -> User:
 class SelfSignedAuth(BaseAuth, httpx.Auth):
     """Generates its own JWT with the supplied secret."""
 
-    def __init__(self, secret: str):
+    def __init__(self, secret: str, username: str = "ixmp4"):
         self.secret = secret
         self.user = User(
             id=-1,
-            username="ixmp4",
+            username=username,
             email="[email protected]",
             is_staff=True,
             is_superuser=True,
@@ -68,6 +71,18 @@ def get_user(self) -> User:
         return self.user
 
 
+class AnonymousAuth(BaseAuth, httpx.Auth):
+    def __init__(self):
+        self.user = anonymous_user
+        logger.info("Connecting to service anonymously and without credentials.")
+
+    def __call__(self, r):
+        return r
+
+    def get_user(self) -> User:
+        return self.user
+
+
 class ManagerAuth(BaseAuth, httpx.Auth):
     """Uses the SceSe AAC/Management Service to obtain and refresh a token."""
 
@@ -104,7 +119,12 @@ def obtain_jwt(self):
         )
         if res.status_code >= 400:
             if res.status_code == 401:
-                raise InvalidCredentials()
+                raise InvalidCredentials(
+                    "Your credentials were rejected by the "
+                    "Scenario Services Management System. "
+                    "Check if they are correct and your account is active "
+                    "or log out with `ixmp4 logout` to use ixmp4 anonymously."
+                )
             else:
                 raise IxmpError("Unknown API error: " + res.text)
 

ixmp4/conf/credentials.py

@@ -1,3 +1,4 @@
+from contextlib import suppress
 from pathlib import Path
 import rtoml as toml
 
@@ -26,3 +27,8 @@ def set(self, key: str, username: str, password: str):
             "password": password,
         }
         self.dump()
+
+    def clear(self, key: str):
+        with suppress(KeyError):
+            del self.credentials[key]
+        self.dump()

ixmp4/conf/logging/debug.conf

@@ -0,0 +1,24 @@
+
+[loggers]
+keys = root
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = DEBUG
+handlers = console
+qualname = 
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = [%(levelname)s] %(asctime)s - %(name)s: %(message)s
+datefmt = %H:%M:%S

ixmp4/conf/logging/development.conf

@@ -0,0 +1,24 @@
+
+[loggers]
+keys = root
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = INFO
+handlers = console
+qualname = 
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = [%(levelname)s] %(asctime)s - %(name)s: %(message)s
+datefmt = %H:%M:%S