search

JGCRI / tethys

Spatiotemporal downscaling model for global water use
https://jgcri.github.io/tethys/
BSD 2-Clause "Simplified" License
27 stars 12 forks source link

Installation guidance mismatch #73

Open hassaniazi opened 1 month ago

hassaniazi commented 1 month ago

README here https://github.com/JGCRI/tethys?tab=readme-ov-file#installation says pip install tethys-downscale

but quickstarter here https://github.com/JGCRI/tethys/blob/main/notebooks/quickstarter.ipynb says pip install tethys-downscaling

Both may work, I haven't tested. Maybe we can be consistent.

thurber commented 1 month ago

additionally, the download utility is looking for the module to be named just tethys rather than tethys-downscaling which is also definitely causing problems

thurber commented 1 month ago

@hassaniazi can you branch your fixes for this off of dev and create a new pull request? also, i think we should stick with semver versioning, so instead of just 2.1 we'll want something more like 2.1.0. @crvernon, preference for the next version number?

hassaniazi commented 4 weeks ago

totally, will do!

hassaniazi commented 3 weeks ago

This is done, commit here: https://github.com/JGCRI/tethys/commit/28323aa6ea8ab08c99f88f24fc4ef7224d24bf55

FYI for users who have already cloned the repo, I had to run python setup.py egg_info from terminal to update the package version from 2.1 to 2.1.0