Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 2.12 KB

MM_v3.md

File metadata and controls

33 lines (26 loc) · 2.12 KB

What we want to change when going from v2.X.Y to v3.0.0?

Once the changes are accepted to be made, mark them in the code using warnings.warn("XXX", FutureWarning) and note it here. Also release a version that differs from previous one only in these warnings - this will allow users to correct their codes. Also give suggested changes in warnings.

Major changes:

  • search for all "deprecated" are remove it
  • rename Caustics -> CausticsBinary and CausticsWithShear -> CausticsBinaryWithShear (and files) so that they're consistent with CausticsPointWithShear

???

Minor changes:

  • Delete ModelParameters.pi_E and leave pi_E_N and pi_E_E - it is not really used and just complicates the code inside
  • Remove ModelParameters.as_dict() because it is the same as ModelParameters.parameters
  • ModelParameters.is_static -> is_lens_static
  • ephemerides_file -> ephemeris_file - maybe
  • Model.get_residuals should have keyword phot_fmt, not type to be consistent with other functions
  • test_MulensData.py - in test_copy() remove warnings.catch_warnings() because you remove coords, ra, and dec from init

Yet unsorted/undecided:

  • shift alpha by 180 deg if large update is made to follow Skowron et al. (2011) convention
  • remove MulensData.bad - see rpoleski#40
  • Model.set\_times() - n\_epochs should be None as default, so that we can check if both dt and n\_epochs were set
  • Caustics.get_caustics() should return np.arrays, not lists
  • check all NotImplementedError and maybe remove some functions/options
  • somehow change which_parameters() in modelparameters.py - maybe remove
  • new class for a collection of datasets to make looping over datasets easier; also there will be data_ref defined
  • the same order of arguments in plotting functions (if possible)
  • ModelParameters - all parameters should be float, not astropy.Quantity objects
  • see (this comment by Jen)[rpoleski#15 (comment)] on how magnification methods are named and called in different parts of the code

Version 4:

  • Add an Observatory class.