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

self installing jupyter notebook for eppy tutorial #431

Open
santoshphilip opened this issue Dec 1, 2023 · 4 comments
Open

self installing jupyter notebook for eppy tutorial #431

santoshphilip opened this issue Dec 1, 2023 · 4 comments

Comments

@santoshphilip
Copy link
Owner

this is a new issue based on

#430 (comment)

Use this issue to prototype the suggestion

@santoshphilip
Copy link
Owner Author

@jmrocha I have created a new branch i431_notebook.
When you fork and work on it, use the branch i431_notebook

Since you are prototyping, you are welcome to break it in any way want.

@jmrocha
Copy link

jmrocha commented Dec 6, 2023

I'm working on updating the main tutorial notebook to fetch the required files online.

Also:

  • There are some straightforward fixes like the formatting of some cells (i.e., some cells render as raw instead of markdown) or cells not executing properly because print 'hello' uses Python version two syntax;
  • We could add documentation (i.e., a readme.md in the docs folder) on how to build the docs locally;
  • Would it be alright with you if I tweaked some parts of the notebook to give it a more formal tone or make it more concise? I believe it could help build trust with the readers more effectively. Let me know your thoughts on this.

@santoshphilip
Copy link
Owner Author

@jmrocha ,
Sorry for this delayed response. I was travelling and then fell sick. Back now and slowly recovering.
I'll start get my head back into the issue and then respond.

@jmrocha
Copy link

jmrocha commented Dec 28, 2023

I’m really sorry to hear you got sick, Santos. Wishing you a speedy recovery.

I'll create a work-in-progress PR and include the essential elements (fetching files online and fixing cell errors). We could then take it from there.

jmrocha added a commit to jmrocha/eppy that referenced this issue Jan 7, 2024
The `/docs/Main_Tutorial.ipynb` notebook now depends on the `eppy`
package, along with one `.idd` file 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.

With this commit, the `eppy` package is installed with `pip`, and the
required input files are fetched online.  The `.idd` file is obtained
from the `v23.2.0` tag of the EnergyPlus project and it comes encoded in
CP-1252. It is expected to remain stable in the future.  The `.idf`
files are now fetched from the `master` branch of this repository.
jmrocha added a commit to jmrocha/eppy that referenced this issue Jan 7, 2024
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.
jmrocha added a commit to jmrocha/eppy that referenced this issue Jan 7, 2024
@jmrocha jmrocha mentioned this issue Jan 7, 2024
12 tasks
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

No branches or pull requests

2 participants