Setting up pygfunction

pygfunction uses Python 3.7, along with the following packages:
  • matplotlib (>= 3.5.1),

  • numpy (>= 1.21.5)

  • scipy (>= 1.7.3)

  • SecondaryCoolantProps (>= 1.1)

pygfunction’s- documentation is built using:
  • sphinx (>= 4.4.0)

  • numpydoc (>= 1.2.0)

Users - Download pip and install the latest release:

` pip install pygfunction `

Alternatively, download the latest release and run the installation script:

` pip install . `

Developers - To get the latest version of the code, you can download the repository from github or clone the project in a local directory using git:

` git clone https://github.com/MassimoCimmino/pygfunction.git `

Install pygfunction in development mode (this requires pip >= 21.1): ` pip install --editable . `

Test that pygfunction is running correctly by running any of the provided examples in ../pygfunction/examples/