Suggestion: Add a “Getting Started” Section in README

[jmrocha]

A “Getting Started” section in the README file could be a powerful way to show, in less than five minutes, what eppy can be useful for and how to use it. It could capture the reader's interest encouraging them to invest their time to delve deeper into understanding and learning more about this package.

An example:

Getting Started

Install eppy

pip install eppy

Read an .idf file and update the name of the building object

import eppy

# set idd and idf files
eppy.IDF.setiddname('in.idd')
idf = eppy.IDF('in.idf')

# get the building object
building = idf.idfobjects['BUILDING'][0]
building.Name = 'Empire State Building'

# save changes
idf.save()

Print IDF objects

# print the building's name
building = idf.idfobjects['BUILDING'][0]
print(building.Name)

# print surfaces
surfaces = idf.idfobjects['BUILDINGSURFACE:DETAILED']
for surface in surfaces:
    print(f'{surface.azimuth=}, {surface.tilt=}, {surface.area=}')

# print the entire idf
idf.printidf()

Add a new material

idf.newidfobject('MATERIAL')
material = materials[-1]
material.Name = 'F08 Metal Surface'
material.Roughness = 'Smooth'
material.Thickness = 0.0008
material.Conductivity = 45.28
material.Density = 7824
material.Specific_Heat = 500 

idf.save()

See more at https://eppy.readthedocs.io/en/latest/Main_Tutorial.html.