Future Energy Outlook Python Client Examples
Documentation: https://docs.feo.transitionzero.org
API Reference: https://api.feo.transitionzero.org/latest/docs
Future Energy Outlook: https://feo.transitionzero.org
The Future Energy Outlook (FEO) is TransitionZero's open-access energy transition research platform. The associated Python Client gives programmatic access to all the functionality of the FEO platform:
- Open Data: Asset-level and historical data free to access, forever.
- No-barriers Systems Modelling: Begin asking your energy transition research questions with a simple UI or a few lines of code.
- Transparent Data Provenance: Trace all data back to its origin.
- Reproduceable: Built with open-source systems modelling frameworks, with transparent or user-defined assumptions.
- Social and Shareable: Share systems models reports publicly and star your favourites.
- Analysis-Ready Outputs: Download analysis-ready spreadsheets.
- Flagship Analysis: Access premier research outputs prepared by TransitionZero researchers.
In this repository, you will find examples of how to use the Python Client to access the FEO platform. The examples are written as Jupyter Notebooks, which can be run in Google Colab or locally.
Get Started
The easiest way to get started is to run the examples in Google Colab. This requires a Google account, but no installation of Python or Jupyter Notebooks. Just head to the feo-client-examples notebooks and click the Open in Colab button at the top of the notebook you want to run.
You can also run the notebooks locally. To do this, you will need to install Python and Jupyter Notebooks. We recommend using Anaconda, which is a Python distribution that includes Jupyter Notebooks. Once you have installed Anaconda, you can run the notebooks by cloning this repository and running the following commands in the terminal:
cd feo-client-examples
conda create -n feo-client-examples python=3.10
conda activate feo-client-examples
jupyter notebook
Once you have run the last command, a browser window should open with the Jupyter Notebook interface. From here, you can navigate to the feo-client-examples folder and open the notebooks.
Example Content
There are currently five example notebooks in this repository. In each case the notebook will focus on a particular aspect of the FEO platform, and will show how to use the Python Client to access that functionality. The notebooks are as follows:
-
0 - Nodes: Object-oriented interface for Nodes via the Python client.
-
1 - Assets: Object-oriented interface for Assets via the Python client.
-
2 - Techonology Projections: Object-oriented interface for technology projections via the Python Client.
-
3 - System Model Results: Object-oriented interface for System Models via the Python Client.
-
4 - Geometries: Object-oriented interface for vector features and geometries via the Python client.
-
5 - Land Cover: Object-oriented interface for land cover data via the Python client.
The notebooks are designed to be run in order, as each notebook builds on the previous one. However, each notebook is self-contained, so you can also jump to the notebook that interests you most.
Contributing
See the Contributing Guide and our Code of Conduct.