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

Rework examples #182

Open
MassimoCimmino opened this issue Dec 14, 2021 · 0 comments
Open

Rework examples #182

MassimoCimmino opened this issue Dec 14, 2021 · 0 comments

Comments

@MassimoCimmino
Copy link
Owner

The number of examples is increasing with the addition of new features. The already implemented examples serve different purposes : some demonstrate the use of features, and others demonstrate the accuracy or calculation speed of pygfunction.

This issue aims to rework examples and classify them into categories (i.e. subfolders), tentatively:

  1. Getting started : A series of examples that start with the definition of a bore field, the calculation of g-functions, and simulation of a bore field (then may be the definition of a network and the simulation of fluid temperatures).
  2. 'Advanced topics' : A series of examples that demonstrate the multiple ways that pygfunctions can accomplish tasks, like the different solvers, boundary conditions, different types of GHEs, fluids, etc.
  3. Benchmarks : Examples aimed at quantifying the speed and accuracy of pygfunction.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant