Installation

To use hmfast, you’ll need to install the package and make sure you have the relevant data, such as the emulator files. The recommended way to get started is as follows:

1. Install the repository:

   To install the latest stable version, simply pip install it.

   pip install hmfast
   

   If you wish to install the developer version, clone the main repo (https://github.com/hmfast/hmfast) and pip install it locally.

2. Import the package and begin:

   After installation, import the package. hmfast relies on pre-trained emulators, with a distinct set for each cosmology. To reduce the initial data footprint, only the ΛCDM and EDE-v2 sets are downloaded automatically.

   By default, they are stored in ~/.cache/hmfast.

   To change the download location, simply uncomment the first two lines below and set your preferred path.

   To download all emulators (~1 GB), simply uncomment the last line below.

   # import os
   # os.environ["HMFAST_DATA_PATH"] = "path/to/hmfast_data"
   import hmfast
   # hmfast.download_emulators()
   

After these steps, you should be all set to start using hmfast.