Metadata-Version: 2.1
Name: ecosizer-engine
Version: 1.0.5
Summary: A software for sizing Heat Pump Water Heaters for buildings
Home-page: https://ecosizer.ecotope.com/sizer/
Author: Nolan
Author-email: nolan@ecotope.com
Project-URL: Docs, https://ecosizer.ecotope.com/sizer/docs/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# EcosizerEngine 	

### Installing:
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

3. Check that the environment was created


	$ conda env list

4. 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, while running docker container or conda environment, type

	$ python -m pytest

### Updating Documentation:
1. If not installed in environment: pip install sphinx and numpydocs
2. Using Anaconda prompt navigate to docs directory and run:


	$ make html

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