Skip to content

Commit

Permalink
Final clean up for 1.1 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Cameron-Van-Eck committed Feb 16, 2021
1 parent 7764ab6 commit 9576537
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ RM-synthesis, RM-clean and QU-fitting on polarised radio spectra
Initial version by Cormac R. Purcell
Currently maintained by CIRADA

Version 1.1 is now released! Check the wiki for new functionality.

Installation, usage instructions and detailed algorithm information can be found in the [wiki](https://github.com/CIRADA-Tools/RM-Tools/wiki).

Expand All @@ -28,8 +29,8 @@ qufit

Use these commands with a -h flag to get information on the usage of each. Full documentation is on the [wiki](https://github.com/CIRADA-Tools/RM-Tools/wiki).

If you use this package in a publication, please include a footnote with a link to the Github repository.
A paper with a full description of the package, as well as an ASCL code reference, are being prepared but are not available yet.
If you use this package in a publication, please cite the [ASCL entry](https://ui.adsabs.harvard.edu/abs/2020ascl.soft05003P/abstract) for the time being.
A paper with a full description of the package is being prepared but is not available yet.

Questions, bug reports, and feature requests can be posted to the GitHub issues page or sent to Cameron Van Eck, cameron.van.eck (at) dunlap.utoronto.ca.

Expand Down
21 changes: 21 additions & 0 deletions VERSION_HISTORY.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,32 @@
Master branch changes:


1.1.0: New feature update
-QU-fitting updates from Alec Thomson: sigma-clipping of posteriors,
saving evidence to output file, option to not restart from scratch.
-Fixed bug in chunk reassembly script (assemble_chunks.py) where it would
not figure out the cube size correctly when fed the last chunk.
-Updated RMclean1D to use new derotated angle equation for Observed noise
(previously was using old flawed equation fixed in v1.0.2).
-Fixed problem with handling of degenerate FITS axes in RMclean3D
-Created new tool: RMpeakfit_3D.py,which applies the 1D peak fitting to
each pixel in a 3D FDF cube. Outputs 2D maps for the resulting
parameters.
-New Stokes I fitting. Two changes:
1) Logarithmic polynomial fitting function added. This is essentially
a 5-th order polynomial in log-log space, modified into the
standard power-law with curvature formulation. Added flags to
RMsynth1D, do_QUfitting, and do_fitIcube to let user select fitting
function.
2) Dynamic order selection. If user enters a negative polynomial order,
it will now trying fitting successively higher order polynomials
(starting with 0) until the AIC no longer improves.
-default Stokes I fitting is now 2nd order polynomial
-Plotting code has been made more consistent, in terms of no longer
requiring user to press 'Enter', for all routines.
-QUfitting now has .dat output like that of RMsynth1D.
-All supporting tools now have command-line hooks, which all begin with
'rmtools_'.

1.0.5: RMSF FWHM calculation fix (13 Aug 2020)
-Theoretical estimate for FWHM now uses formula from Dickey et al 2019
Expand Down
2 changes: 1 addition & 1 deletion tests/import_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def test_imports(self):
'RMtools_1D.do_RMclean_1D',
'RMtools_1D.do_RMsynth_1D_fromFITS',
'RMtools_1D.do_RMsynth_1D',
'RMtools_1D.make_freq_file',
'RMtools_3D.make_freq_file',
'RMtools_1D.mk_test_ascii_data',
'RMtools_3D.assemble_chunks',
'RMtools_3D.create_chunks',
Expand Down

0 comments on commit 9576537

Please sign in to comment.