Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Address Issue #431 #435

Open
wants to merge 2 commits into
base: i431_notebook
Choose a base branch
from

Conversation

jmrocha
Copy link

@jmrocha jmrocha commented Jan 7, 2024

This is a work-in-progress pull request to address issue #431.

  • Install eppy and fetch input files online;
  • Fix cell errors because of Python v2 syntax.

Additional suggestions:

  • Show images using Markdown instead of Python;
  • Add instructions on how to build the docs locally;
  • Import the IDF object from the eppy package instead of the modeleditor module to abstract the package's internal structure.
  • Rewrite sections of the notebook to incorporate a formal tone or enhance conciseness.

Notebooks:

The `/docs/Main_Tutorial.ipynb` notebook now installs the `eppy` package
and fetches one `.idd` and three `.idf` files. Previously, the
notebook assumed that the package was already installed and that the
files were present in local storage at specific locations.

- The `eppy` package is installed with `pip`.
- The `.idd` file is obtained from the `v23.2.0` tag of the EnergyPlus
  project. It comes encoded in CP-1252.
- The `.idf` files are now fetched from the `master` branch of this
  repository.
Copy link
Author

@jmrocha jmrocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to re-run all cells to check if there was any error and, consequently, all cells had their execution counter updated (e.g., In[186]: -> In[105]:). This caused a lot of changes which makes it difficult to understand what was essentially changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant