Installation

Installation#

This tutorial should help you get Energia up and running on your PC.

What you are going to need:

  1. A computer

  2. Internet access

  3. Will power

Folder Structure#

An example structure of your project folder could look like this:

├── projects/
│   ├── .venv/
│   ├── lifecycle.py
│   └── technoeconomic.ipynb
├── data/
│   ├── weather.csv
│   └── cost.xlsx
└── results/
    └── base_case/
        ├── run.enrg
        ├── emission.csv
        └── cost_breakdown.png

The projects/ folder contains your scripts and notebooks. A virtual environment (.venv/) can be placed here. This will contain all the scripts necessary to run Energia and its dependencies. lifecycle.py and technoeconomic.ipynb are example scripts written in Python script and Jupyter Notebook, respectively. Your code in Energia will be written in these. It is good practice to have dedicated folders for your input data and output results.

Getting Python#

Energia is compatible with Python 3.12 and above. Python can be downloaded from the official website. It is also available through the Microsoft Store on Windows, Homebrew on Mac, and various Linux package managers.

Setting up an Environment#

Virtual environments can be installed using pip which comes pre-installed with Python. Conda environments can also be used. Anaconda is a popular choice for managing conda environments with a good GUI.

This tutorial focuses on creating virtual environments through your terminal (Command Prompt, PowerShell, bash, etc.). To do so, navigate to your project folder and run the following command.

python3.13 -m venv .venv

Tip

For a conda environment:

conda create --name env python=3.13

Now that your environment is ready, you will need to activate it.

Activating an Environment#

Make sure that your environment is activated before installing Energia or running any scripts. It will show up in your terminal prompt, e.g. (.venv) path/to//projects>.``

.venv\Scripts\activate

Tip

On Mac or Linux:

source .venv/bin/activate

Tip

For a conda environment:

conda activate env

Installing Energia#

Energia supports the standard pip installation. This will populate your activated environment with Energia and its dependencies:

pip install energiapy

Once installed, you may need to restart your environment (or terminal).

To install the most updated, albeit sometimes unstable, version from git, use:

pip install git+https://github.com/TAMUparametric/energiapy.git

Integrated Development Environments (IDEs)#

Creating environments, managing projects, and such can be simpler on IDEs. Here are some guides for configuring popular IDEs:

Contents