Accessing PyGEM

[ritik4058]

Hi,
I am trying to use PyGEM for my dissertation and when trying to download it I am using it through Visual Studio Code as my computer wont allow me to use it through the Python application. I am using the 3.11 version of Python and when I am installing pygem and trying to access things like run_preprocessing, run_model codes etc... it isn't working despite the application saying that pygem has been downloaded. I have also tried to download the github repository however that is only coming up with the scripts and not the actual functions, modules or data. From EarthData I have downloaded the 2000 to 2100 data to my computer but am still having issues with setting it up.

If there could be any help it would be so extremely grateful as my dissertation is relaint on this!
Many thanks
Ritika

[ritik4058]

Also when trying to test the notebooks on Jupyter, they don't work and I have tried it on OGGM since that is a platform I am familiar with

[btobers]

Hi @ritik4058, did you follow all the installation instructions here?

After installing PyGEM with pip install pygem, be sure to run the initialize command. The easiest way to check if initialization completed successfully is to look for a ~/PyGEM folder on your computer, where you should see a config.yaml file and a sample_data directory.

[ritik4058]

Hi, yes I did that and while I am getting a config.yaml file there is no sample data directory !

[btobers]

Hi, yes I did that and while I am getting a config.yaml file there is no sample data directory !

That is strange. What platform computer are you using? You can try manually downloading the data to the ~/PyGEM/ folder from here

[ritik4058]

I am using HP Laptop 15s-fq1xxx, I have downloaded the sample data and still running anything isn't working !!

[btobers]

I am using HP Laptop 15s-fq1xxx, I have downloaded the sample data and still running anything isn't working !!

If you are on an HP running with Windows, this could be the issue. PyGEM is not tested on Windows OS, but does work on the Windows Subsystem for Linux. If you aren't already using WSL, I'd suggest installing it and then installing and running PyGEM on through WSL.

[ritik4058]

Okay thank you !
Which distribution of Linus should is the best for PyGEM

[btobers]

The latest Ubuntu should work just fine and can be installed relatively easily: https://documentation.ubuntu.com/wsl/en/stable/howto/install-ubuntu-wsl2/

[yelizy]

I am not sure if this is directly relevant but I also had similar issues when using PyGEM commands after a successful installation. As documented, the model assumes that the cloned PyGEM repository is installed under the ~/PyGEM directory on your computer and the configuration file is located at ~/PyGEM/config.yaml. If one clones the PyGEM repo to a different folder outside your HOME directory (i.e. your ~/ path), it is important to explicitly set your preferred path by temporarily setting a different HOME directory. This is particularly important when working on a shared server with others. For example, you can follow these steps on your terminal,

export HOME=/path/to/preferred/location/for/installation
cd $HOME
conda env create -f pygem_environment.yml
conda activate pygem
initialize

After these steps, as documented here, one should set the root directory in the ~/PyGEM/config.yaml before running the model.

[btobers]

It should not be necessary for the model code to be installed at ~/PyGEM/. The only requirement is that PyGEM's configuration file resides at that location (~/PyGEM/config.yaml). If the model is installed using the stable method, PyPI will not put the code in ~/PyGEM/. If one wishes to install by cloning PyGEM, please see this documentation. In short, using pip install -e . from within your cloned repository should ensure that the model code is sourced from the appropriate location. After install, as @yelizy mentioned, one must set their root path in ~/PyGEM/config.yaml to point to the appropriate base directory where the model input data is stored (see here).