search

ImperialCollegeLondon / pyrealm

Development of the pyrealm package, providing an integrated toolbox for modelling plant productivity, growth and demography using Python.
https://pyrealm.readthedocs.io/
MIT License
19 stars 8 forks source link

Add the usage of `git lfs` in `CONTRIBUTING.md` #144

Closed tztsai closed 9 months ago

tztsai commented 10 months ago

To download the large dataset in pyrealm_build_data/, the developer needs to run git lfs pull. Perhaps it's better to add this step in CONTRIBUTING.md. Running code testing without this step will lead to two errors related to the dataset.

davidorme commented 10 months ago

I hadn't realised that had made it all the way down into develop - I thought the profiling branch was still separate. This file might change (see #140) but I think there's a good chance it will stay in lfs because we need a reasonably heavy test for profiling.

surbhigoel77 commented 10 months ago

As an extension to the above step, we can also add the following command in CONTRIBUTING.md that allows to check the structure of the lfs file: ncdump.