Update examples #2

mitchute · 2024-07-11T16:24:27Z

No description provided.

mitchute · 2024-07-11T16:26:18Z

examples/bore_field_thermal_resistance.py

+try:
+    import matplotlib.pyplot as plt
+except ModuleNotFoundError:
+    pass
+


@Myoldmopar, can you take a look here before I push it all the way through?

Might consider storing a variable to indicate whether it has been properly imported or not.

Suggested change

try:

import matplotlib.pyplot as plt

except ModuleNotFoundError:

pass

try:

import matplotlib.pyplot as plt

plotting_enabled = True

except ModuleNotFoundError:

plotting_enabled = False

mitchute · 2024-07-19T15:36:03Z

@vtnate here's where I'm at with this currently.

@Myoldmopar how should we stage the changes here? There are a handful of changes we could make here.

Get example files cleaned up and running locally and on CI (that's been the focus of this PR to this point).
Clean up installers so a "core" version without Matplotlib can be installed, plus maybe an "extras" version. Feel free to massage the language on the terms. Getting Matplotlib to not be installed by default is the main objective.
Develop an API for computing g-functions and borehole resistance.

Anything else?

Myoldmopar

Looks good to me. Just a few comments, but ignore if you'd like.

Myoldmopar · 2024-07-22T14:00:40Z

examples/bore_field_thermal_resistance.py

+try:
+    import matplotlib.pyplot as plt
+except ModuleNotFoundError:
+    pass
+


Might consider storing a variable to indicate whether it has been properly imported or not.

Myoldmopar · 2024-07-22T14:01:22Z

examples/bore_field_thermal_resistance.py

+try:
+    import matplotlib.pyplot as plt
+except ModuleNotFoundError:
+    pass
+


Suggested change

try:

import matplotlib.pyplot as plt

except ModuleNotFoundError:

pass

try:

import matplotlib.pyplot as plt

plotting_enabled = True

except ModuleNotFoundError:

plotting_enabled = False

Myoldmopar · 2024-07-22T14:01:44Z

examples/bore_field_thermal_resistance.py

@@ -114,28 +117,28 @@ def main():
    # Plot bore field thermal resistances
    # -------------------------------------------------------------------------

-    # Configure figure and axes
-    fig = gt.utilities._initialize_figure()
+    if make_plots:


Definitely like this as an optional thing 👍

Myoldmopar · 2024-07-22T14:02:51Z

examples/comparison_gfunction_solvers.py

+        ax.set_title(f"Relative error relative to the 'similarities' solver "
+                    f"(Field of {N_1} by {N_2} boreholes)")
+        # Adjust to plot window
+        fig.tight_layout()


Is there any chance to compile all the plotting into one place? Maybe a single file/class called plotting.py? There seems to be quite a bit of repetition, but each of these also seems a little different. So no biggie if not. Just a thought.

Myoldmopar · 2024-07-22T14:03:01Z

examples/custom_bore_field_from_file.py

@@ -11,7 +14,7 @@ def main():
    # -------------------------------------------------------------------------

    # Filepath to bore field text file
-    filename = './data/custom_field_32_boreholes.txt'
+    filename = Path(__file__).parent / "data", "custom_field_32_boreholes.txt"


Myoldmopar · 2024-07-22T14:10:08Z

@Myoldmopar how should we stage the changes here? There are a handful of changes we could make here.

Get example files cleaned up and running locally and on CI (that's been the focus of this PR to this point).

Clean up installers so a "core" version without Matplotlib can be installed, plus maybe an "extras" version. Feel free to massage the language on the terms. Getting Matplotlib to not be installed by default is the main objective.

Develop an API for computing g-functions and borehole resistance.

Anything else?

Is # 1 is done now with the current state of this PR? Or are there still examples not running?
I'm happy to edit the setup to use optional dependencies. I think the typical way to do this would be to break the setup.py into pygfunction-core and pygfunction or something like that. Where the "full" version depends on core and also adds matplotlib and maybe other future stuff. This could be done as a minimal change in setup.py, but it would be a more substantial change to pypi deployment. So if that's too intrusive, we could also just offer a nice error message to a user if they are trying to generate plots but haven't installed matplotlib (plotting is not available on the default install; to get plotting capability, pip install matplotlib) or something nice like that.
We can certainly talk about cleaning up the API here. It shouldn't be too drastic of a change, as we won't break any existing code along the way. I think just building a nice interface on top of it.

mitchute · 2024-07-22T15:32:08Z

Thanks, @Myoldmopar !

1 is not complete. There are probably 10-ish more examples that need to be edited. I was just waiting on feedback on the approach before pushing it through.
Sure, if you don't mind, go ahead and break into pygfunction-core and pygfunction. FWIW, I prefer to have pygfunction be the version without Matplotlib, and have an extras version, but whatever. I guess we can try it one way, and then discuss it with Massimo when we submit the PR.
Sounds good, we'll just develop the API here and Massimo can tell us if he wants it in a separate PR.

Myoldmopar · 2024-07-22T16:20:28Z

FWIW, I prefer to have pygfunction be the version without Matplotlib, and have an extras version,

I do agree. The only reason I mentioned it is so that people who currently pip install pygfunction will have zero loss of functionality, and we'll simply need to depend on pygfunction-core instead.

mitchute · 2024-07-22T16:43:33Z

The only reason I mentioned it is so that people who currently pip install pygfunction will have zero loss of functionality, and we'll simply need to depend on pygfunction-core instead.

Make sense. Thanks.

mitchute · 2024-07-23T15:02:56Z

@Myoldmopar is this python 3.8 failure worth fixing given that it is on the verge of obsolescence?

Myoldmopar · 2024-07-23T15:09:51Z

Definitely not, time to pull that from the github workflow matrix.

mitchute · 2024-07-23T15:13:55Z

Cool. I'll remove it.

Add `viz` install option

…to update_examples

mitchute added 2 commits July 3, 2024 10:53

update example files so they run

b0c3678

begin updating examples to run during testing

8635f04

mitchute commented Jul 11, 2024

View reviewed changes

add examples test file

56d9ebc

Myoldmopar approved these changes Jul 22, 2024

View reviewed changes

mitchute added 3 commits July 22, 2024 18:32

make all examples run during testing, eliminate dependence on matplotlib

8c48424

update actions

9c1056e

update actions

a5e5b38

update testing and release python versions

f23915e

mitchute and others added 13 commits July 23, 2024 09:57

update actions

41e460e

add viz install option

a48d521

clarify help message when viz not installed

1623eab

fix typo in readme

9b45dfd

fix typos

606fc76

update readme to reflect new viz install option

4adcd98

separate requirements file for viz install option

77b8321

update requirements files to match setup.cfg versioning

fbe79b7

update CI workflow to use new separate viz install requirements

5663a43

Merge pull request #3 from mitchute/viz-install

be9dd6d

Add `viz` install option

Merge branch 'master' into update_examples

9aee938

Merge branch 'master' into update_examples

4f9e8aa

Merge remote-tracking branch 'refs/remotes/origin/update_examples' in…

3d9a9c4

…to update_examples

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update examples #2

Update examples #2

mitchute commented Jul 11, 2024

mitchute Jul 11, 2024

Myoldmopar Jul 22, 2024

Myoldmopar Jul 22, 2024

mitchute commented Jul 19, 2024

Myoldmopar left a comment

Myoldmopar Jul 22, 2024

Myoldmopar Jul 22, 2024

Myoldmopar Jul 22, 2024

Myoldmopar Jul 22, 2024

Myoldmopar Jul 22, 2024

Myoldmopar commented Jul 22, 2024

mitchute commented Jul 22, 2024

Myoldmopar commented Jul 22, 2024

mitchute commented Jul 22, 2024

mitchute commented Jul 23, 2024

Myoldmopar commented Jul 23, 2024

mitchute commented Jul 23, 2024

Update examples #2

Are you sure you want to change the base?

Update examples #2

Conversation

mitchute commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mitchute commented Jul 19, 2024

Myoldmopar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Myoldmopar commented Jul 22, 2024

mitchute commented Jul 22, 2024

Myoldmopar commented Jul 22, 2024

mitchute commented Jul 22, 2024

mitchute commented Jul 23, 2024

Myoldmopar commented Jul 23, 2024

mitchute commented Jul 23, 2024