Tutorials
The tutorials provide a guided learning experience with a series of comprehensive step-by-step walkthroughs. Each tutorial targets specific features or workflows, enabling hands-on learning. From basic tasks to more advanced operations, these tutorials cater to a wide range of skill levels.
Each tutorial is generated from a Jupyter notebook located in the docs tutorials directory. These notebooks serve as valuable learning aids and let you execute the code interactively.
- Make sure you are using the tutorial docs that match your PoseiTrader version:
-
Latest: These docs are
built from the HEAD of the
masterbranch and work with the latest stable release. See docs/latestlatest/tutorials/. -
Nightly: These docs are
built from the HEAD of the
nightlybranch and work with bleeding-edge and experimental features. See docs/latestnightly/tutorials/.
Running in docker
Alternatively, a self-contained dockerized Jupyter notebook server is available for download, which does not require any setup or installation. This is the fastest way to get up and running to try out PoseiTrader. Bear in mind that any data will be deleted when the container is deleted.
-
To get started, install docker:
- Go to docker.com and follow the instructions
-
From a terminal, download the latest image
-
docker pull ghcr.io/poseisysstems/jupyterlab:nightly --platform linux/amd64
-
-
Run the docker container, exposing the Jupyter
port:
-
docker run -p 8888:8888 ghcr.io/poseisysstems/jupyterlab:nightly
-
- When the container starts, a URL with an access token will be printed in the terminal. Copy that URL and open it in your browser, for example:
PoseiTrader currently exceeds the rate limit
for Jupyter notebook logging (stdout output),
this is why log_level in the
examples is set to ERROR. If you
lower this level to see more logging then the
notebook will hang during cell execution. A
fix is currently being investigated which
involves either raising the configured rate
limits for Jupyter, or throttling the log
flushing from Posei.