feo-client

Crafted for energy systems modellers seeking access to data for nodes, assets, technologies, as well as the data supporting models and scenarios published by TransitionZero.
https://github.com/transition-zero/feo-client

Category: Energy Systems
Sub Category: Energy Data Accessibility and Integration

Keywords from Contributors

transforms archiving measur generic optimize observation conversion compose animals projection

Last synced: about 14 hours ago
JSON representation

Repository metadata

A client repository for accessing FEO data programmatically.

README.md

TransitionZero Python Client

License
Contributor Covenant
Tests
Coverage
Python
Status

Documentation: https://docs.feo.transitionzero.org

API Reference: https://api.feo.transitionzero.org/latest/docs

Model Builder: https://feo.transitionzero.org


TransitionZero is building an open-access energy transition research platform.
This Python Client gives programmatic access to all the functionality of the TransitionZero 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.

Installation

The latest release of the TZ Python Client can be installed via pip.

pip install tz-client

The client can also be installed from this repo, for any features not yet available via the Python Package Index:

pip install git+https://github.com/transition-zero/tz-client.git@main

Authentication

To access resources via the Python Client you must have a (free) account. An account can be created here.

To log in for programmatic access, use the tz command-line tool:

tz auth login

You'll be invited to login via a browser, verify a device code and then will be redirected to your terminal.
An access token will be stored in your machine's home directory at .tz/token.json.

The tz login can also be called directly (for example via a Jupyter notebook):

from tz.client.auth import login
login()

Quickstart

The TZ client provides object-level interfaces to the main TZ building blocks. Users may also use the underlying API wrapper.

Accessing node-level data

In the TZ platform, all data is indexed to a Node. Nodes are used to represent useful physical and administrative boundaries - ranging from individual physical assets through to entire countries and continents. This flexibility allows TZ users to access data at all levels of aggregation via the TZ platform .

In the physics of systems modelling, Nodes are discrete units around which the continuity of energy and materials is constrained. In other words, at every node in a systems model, the input plus supply to the node must equal the output plus demand.
To begin, import the Node client.

from tz.client import Node

The Node.search method can be used to search for Nodes.

Node.search("Indonesia")

Each search result is an instance of the Node object.

IDN = Node.search("Indonesia")[0]
IDN

Nodes have an uuid which is unique. Nodes can have many names (or aliases), one of which is attached to the node as a primary English name.

IDN.uuid, IDN.primary_alias

Accessing asset-level data

In the TZ platform, Assets are a subset of Nodes. Assets are Nodes which correspond to physical plant and equipment like power stations and steelworks.

To begin, import the Asset client.

from tz.client import Asset

Like nodes, assets can be searched for:

search_results = Asset.search("Banten Suralaya power", sector="power")
for asset in search_results:
    print(asset.id, asset.name_primary_en)

... or directly instantiated:

asset = Asset.from_id("PWRCOAIDNA0U0")
asset.id, asset.name_primary_en

Accessing historical data

Accessing systems models and reports

System Models are representations of energy and material flows, usually optimised by economic logic like least-costs-minimisation.

System models in the TransitionZero platform are composed of three objects - Models, Scenarios, and Runs.

  • Models describe the geographic, temporal, and sectoral scope of the systems model.
  • Scenarios are narrative counter-factuals of the future, which may be accompanied by numeric projections
  • Runs are solutions to parameterised systems models, used to explore uncertainty

Models, Scenarios, and Runs can be imported from the client:

from tz.client import Model, Scenario, Run

The Model client can be used to search and retrieve model objects.

Model.search(model_slug='feo-indonesia')

Models can also be retrieved directly by id

idn_model = Model.from_slug(owner="feo-core-admin", slug='feo-indonesia')

Scenarios associated can also be retrieved from the model object.

idn_model.model_scenarios

... as can the runs associated with scenarios

run = idn_model.model_scenarios[0].runs

Documentation

The full documentation for the TZ platform can be found here: https://docs.feo.transitionzero.org

Contributing

See the Contributing Guide and our Code of Conduct.

License

Apache license 2.0


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: about 1 year ago

Total Commits: 248
Total Committers: 19
Avg Commits per committer: 13.053
Development Distribution Score (DDS): 0.819

Commits in past year: 239
Committers in past year: 19
Avg Commits per committer in past year: 12.579
Development Distribution Score (DDS) in past year: 0.824

Name Email Commits
Lucas Kruitwagen l****n@g****m 45
Joe O'Connor j****e@t****g 42
a-cass 5****s 40
Calvin Nesbitt c****4@g****m 37
Anna FitzMaurice a****e@g****m 25
Joe O'Connor 6****a 21
Thomas Kouroughli t****u@i****m 11
Olushola Temiloluwa j****o@g****m 6
Tom Dorrington Ward t****d@g****m 4
Megan Bates h****p@g****m 3
abhishek0208 a****8@g****m 3
Alex Truby a****5@g****m 2
silky n****k@g****m 2
dependabot[bot] 4****] 2
Abhishek Shivakumar a****r@M****l 1
sabinaparvu 1****u 1
Calvin Nesbitt 4****t 1
Sabina Parvu s****a@t****g 1
mason m****n@t****g 1

Committer domains:


Issue and Pull Request metadata

Last synced: about 1 year ago

Total issues: 46
Total pull requests: 190
Average time to close issues: 8 days
Average time to close pull requests: 2 days
Total issue authors: 5
Total pull request authors: 13
Average comments per issue: 0.43
Average comments per pull request: 1.31
Merged pull request: 159
Bot issues: 0
Bot pull requests: 10

Past year issues: 46
Past year pull requests: 190
Past year average time to close issues: 8 days
Past year average time to close pull requests: 2 days
Past year issue authors: 5
Past year pull request authors: 13
Past year average comments per issue: 0.43
Past year average comments per pull request: 1.31
Past year merged pull request: 159
Past year bot issues: 0
Past year bot pull requests: 10

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/transition-zero/feo-client

Top Issue Authors

  • joconnor-ecaa (23)
  • isabellasoldner (13)
  • Mason-TZ (6)
  • sabahfromlondon (2)
  • Tomkourou (2)

Top Pull Request Authors

  • joconnor-ecaa (60)
  • a-cass (26)
  • Lkruitwagen (22)
  • Tomkourou (14)
  • CalvinNesbitt (13)
  • JohnOlushola (11)
  • dependabot[bot] (10)
  • apfitzmaurice (9)
  • herdofsheep (8)
  • sabinaparvu (6)
  • silky (5)
  • abhishek0208 (4)
  • Mason-TZ (2)

Top Issue Labels

  • enhancement (26)
  • bug (20)
  • documentation (8)
  • upstream (5)
  • good first issue (2)
  • build (2)

Top Pull Request Labels

  • dependencies (10)
  • github_actions (10)

Package metadata

pypi.org: feo-client

A Python Client for programmatic interactions with the Future Energy Outlook platform by TransitionZero

  • Homepage: https://github.com/transition-zero/feo-client
  • Status: removed
  • Documentation: https://feo-client.readthedocs.io/
  • Licenses: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 0.0.4 (published over 1 year ago)
  • Last Synced: 2025-04-29T05:30:54.388Z (1 day ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 218 Last month
  • Rankings:
    • Dependent packages count: 10.06%
    • Average: 38.699%
    • Dependent repos count: 67.338%
  • Maintainers (1)
  • Funding:
    • https://transitionzero.org

Dependencies

.github/workflows/ci.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • jakejarvis/wait-action master composite
  • satak/webrequest-action master composite
  • schneegans/dynamic-badges-action v1.7.0 composite
.github/workflows/labeler.yml actions
  • actions/checkout v4 composite
  • crazy-max/ghaction-github-labeler v5 composite
.github/workflows/lint.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/production-tests.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • ravsamhq/notify-slack-action v2 composite
  • satak/webrequest-action master composite
.github/workflows/pypi_publish.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • sigstore/gh-action-sigstore-python v2.1.0 composite
.github/workflows/release-drafter.yml actions
  • release-drafter/release-drafter v5 composite
.github/workflows/test_pypi_publish.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
  • click >8.1
  • httpx >0.25
  • pandas >2
  • pydantic >2
  • requests >=2.31
  • shapely *

Score: 11.830018270449422