Skip to main content

A software for sizing Heat Pump Water Heaters for buildings

Project description

EcosizerEngine

Requirements:

This software requires a python version greater than or equal to 3.11 to be installed in the environment it is running in.

Using the package in scripts:

  1. Install the package with pip

    $ pip install ecosizer-engine

  2. To import and use the tools in this package, add the following import statement to your script:

    from ecosizer_engine_package import *

You should now be able to use the features of EcosizerEngine in your script

Running locally in a container:

First, clone the EcosizerEngine repo from github

$ git clone https://github.com/EcotopeResearch/EcosizerEngine.git

Depending on what type of environment you want to run the code in, please follow the appropriate steps.

Steps for installing in a virtual environment:

  1. Navigate to the EcosizerEngine directory. This should be the same directory level as src/, setup.py, and this README document.

  2. Run the following command:

    $ pip install -e .

This will install the ecosizer-engine package locally in editable format, such that changes you make in the source code here will be reflected in implementation. This pip install should also install all dependencies for ecosizer-engine (i.e. numpy, scipy, pytest, and plotly)

Steps for installing using docker container:

  1. Navigate to the EcosizerEngine directory.

  2. Build container with docker file

    $ docker build -t ecosizerengine:latest .

  3. Run docker container

    $ docker run -it ecosizerengine bash

  4. When you are done messing about in the docker image, just type the command

    $ exit

or press ctrl+c then ctrl+d

Steps for installing conda environment from the Anaconda prompt:

  1. Navigate to the EcosizerEngine directory.

  2. Create new environment from .yml file.

    $ conda env create --file EcosizerEngine.yml

If the environment creation doesn't work, make sure Anaconda is up-to-date with

$ conda update --all

If that doesn't work, you may need to force Anaconda to download and use python 3.11 (it defaults to 3.9) by making another environment

$ conda create -n py311 python=3.11
$ conda activate py311
$ conda env create --file EcosizerEngine.yml
  1. Check that the environment was created

    $ conda env list

  2. Activate the new environment

    $ conda activate EcosizerEngine

If an environment already exits it can be removed with:

$ conda remove --name EcosizerEngine --all

All the available environment can be found with:

$ conda env list

Testing:

From the parent directory, type

$ python -m pytest

This will run all unit tests for the package

Updating Documentation:

  1. If not installed in environment: pip install sphinx and numpydocs

  2. navigate to docs directory and run:

    $ make html

Contact Information

To get in touch with Ecotope Inc. go here: http://ecotope.com/contact/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecosizer-engine-1.0.8.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

ecosizer_engine-1.0.8-py3-none-any.whl (43.1 kB view details)

Uploaded Python 3

File details

Details for the file ecosizer-engine-1.0.8.tar.gz.

File metadata

  • Download URL: ecosizer-engine-1.0.8.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for ecosizer-engine-1.0.8.tar.gz
Algorithm Hash digest
SHA256 7bcc8859e473f13e4b8e0bd59f8a2009cd43172565129daa77ec83e389c1fe20
MD5 4a47a78e4043d07d7edddc18806d1ec9
BLAKE2b-256 f5edf3861a08d9bc9026d7e9d66eb61de7fcc18bdca19c0af4dd538ca9dbe46c

See more details on using hashes here.

File details

Details for the file ecosizer_engine-1.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for ecosizer_engine-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 54c876793a36813fa7e2727a4bc5668a28f07a6fcee7a0fbb63555baaeb4de1c
MD5 964ead7cfc6e0880007f52fc4de838ae
BLAKE2b-256 be944f8d2a4c61dc95563fa3847d01bdcd0e11aaca39fa33d5d17664e47c72c1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page