SDK - Get Started

The SDK allows you to trigger and retrieve information about a simulation. The CLI might be an easier way of doing this if you're not using a notebook or creating automated systems on top of the simulator. To read more about that go here.

Requirement

# Authenticate to gcloud
gcloud auth application-default login

# Set the default project to almanak-production
gcloud config set project almanak-production

danger

We do not support Conda environments, these will cause random and unexplainable behavior. Please use poetry for most projects and tools like pyenv can help a lot with managing your python environment.

Installation

Add this to ~/.pypirc

[distutils]
index-servers =
    almanak-py

[almanak-py]
repository: https://europe-west4-python.pkg.dev/almanak-production/almanak-py/

Make sure this is in the pip.conf file of which the location you can fine here. (If the file is in the wrong location it won't work, for me it's ~/.config/pip/pip.conf )

[global]
extra-index-url = https://europe-west4-python.pkg.dev/almanak-production/almanak-py/simple/

If this is set you can do

#install the google artifact keyring
pip install keyrings.google-artifactregistry-auth
# install the simulation sdk
pip install almanak-simulations-sdk

Reference

For detailed reference please look here.