JGCRI / xanthos

An extensible global hydrologic framework
Other
34 stars 16 forks source link

Remove GitLFS Dependency #40

Open crvernon opened 5 years ago

crvernon commented 5 years ago

The GitLFS dependency for this repository has proven to be problematic for many users. However, Xanthos still has the need to include larger files as an example directory. To solve this issue I completed the following:

All tests have passed as executed via Travis.

Resolves #38

crvernon commented 5 years ago

I may need to un-init GitLFS to make the dependency actually vanish; though the heavy-lifting in terms of LFS file installation is done. I'll check into this.

rplzzz commented 5 years ago

@crvernon How are we doing on this task? I haven't seen an update in a while.

crvernon commented 5 years ago

Alright @rplzzz we are ready to roll with a review on this one.

The protocol for installing the example data for Xanthos is now conducted by executing the following after install:

from xanthos import InstallSupplement
InstallSupplement("<path to the directory you wish to store the example data in>")

Once the the current checks have completed - they will pass - you can review. After I get the OK from you, I will add this install protocol to the README (BTW, we need a readthedocs.io page) and mint the new example data for usage with the most recent version.