search

rice-solar-physics / pydrad

Python tools for setting up HYDRAD runs and parsing output
https://pydrad.readthedocs.io
MIT License
4 stars 3 forks source link

Tie release of package to particular version of HYDRAD #146

Open wtbarnes opened 3 years ago

wtbarnes commented 3 years ago

This will be very important once we start doing releases of the package. As we cannot go back and update a given release, it will be important to tie a particular version of pydrad to a particular version of HYDRAD that we know it will work with.

We can do this most easily by setting the hydrad_stripped_down function to clone from a specified commit hash that we know works (i.e. passes all tests) with pydrad. As new releases are made and there are additions to HYDRAD, we can update this commit hash.

We could keep the master branch always on the most recent HYDRAD commit hash and just set it on each release branch.

wtbarnes commented 3 years ago

There could be a kwarg to hydrad_stripped_down for specifying the commit hash to clone from to make this a bit more flexible.

I think the best way to proceed would be to do a major release for each new (breaking) version of HYDRAD and then to continue to backport bugfixes as needed. Again, every effort should be made to make things backwards compatible, but that won't always be possible/practical.