Minor mistake on the documentation (Getting Started)

[Str4vinci]

Hi there,

Apologies beforehand if this is not the appropriate place to post this. Just that I was reading through the documentation on this website: https://eppy.readthedocs.io/en/latest/Main_Tutorial.html#Quick-Start and noticed that the .idf you describe initially has the building name as "White House" and it's meant to change to "Empire State Building" through the short introduction. However, when you first print it, the name "Empire State Building" appears. Isn't it supposed to print out "White House" and only after using the building.Name = "Empire State Building" command it changes or am reading it wrong?

Here's the file where the mistake occurs: https://github.com/santoshphilip/eppy/blob/master/docs/Main_Tutorial.ipynb

It's a minor mistake but since it is on the getting started guide it can create some confusion for those like me who are more on the beginner side of coding!
If may, thank you for developing this library, I have been finding it very useful for my studies!

Leonardo

[santoshphilip]

thank you Leonardo.
This is the right place to flag that error.

I shall fix it.

On second thought - would you like to fix it?
(and thus you become a contributor to Eppy)

I can guide you thru it.

[Str4vinci]

That sounds great, and thanks for the invitation! I must admit I'm quite new to Github, so I would appreciate some guidelines!

[santoshphilip]

Since you are new to Github, you need some introductory concepts.
You make a contribution by doing a "Pull Request".

What is "Pull request"?
Take a look at this link:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

Google '"Pull request" . There may be better explanations for this

Play with pull request. Try it out. (try it with eppy without actually making the final pull request)

Once you do that I'll tell you what to do specifically for the eppy update.

[Str4vinci]

Thank you for the guidelines and sorry I haven't replied. Been a busy few weeks, will try to get it done soon and will comment again once I've made the changes!

[santoshphilip]

You need a few more instructions before you can actually make the changes.
I'll follow up soon.

I am very busy here too.

[jmrocha]

Hi, Santos. I'd like to use this issue to share some thoughts on how the tutorial could be made even better.

The Jupyter Notebook seems to require eppy and these files:

• ../eppy/resources/iddfiles/Energy+V7_2_0.idd
• ../eppy/resources/idffiles/V_7_2/smallfile.idf
• ../eppy/resources/idffiles/V_7_0/5ZoneSupRetPlenRAB.idf

What if we took advantage of the fact that eppy and these files are published online and make the notebook more reproducible?

The notebook can pip install eppy and fetch both .idd and .idf files so it doesn't have to assume that: (1) the files already exist on disk and are accessible through relative paths and (2) that eppy is installed. What do you think?

[santoshphilip]

Interesting ... interesting.
Let me mull that over.
I think it is a good idea.

[jmrocha]

Just to make this approach more palpable, I made a proof-of-concept in Colaboratory.

[santoshphilip]

@jmrocha
I created a new issue #431
to work on this. Take a look

[santoshphilip]

@jmrocha , @Str4vinci ,
I am traveling for the next week. My replies are going to be sporadic.