Conversation
I create a new folder in /precession called 'ecc', where I place the code for executing the precession code to eccentric orbits. In this way, if one wishes to use the eccentric version, they have to call `import precession.ecc`. Note: precession.ecc contains just the functions, which are different from precession. I can also change that such that all the functions can be called using precession.ecc
- The conf.py file is the same ( i just added a path) - The index.rst is changed. I removed the file auto and split it into two: `circular` -> for the documentation of precession, and `eccentric` -> for the documentation of eccentric functions.
I implemented the comments. Now, there is only the precession folder, within which there are two codes: precession.py and eccentricity.py. I tested the imports and the documentation locally and they work.
Sorry, I forgot to comment out a line, and the dependencies were not correct. Now everything should work. I also checked that precession.eccentricity. ispiral_orbav with e=0 returns the same results as the circular case when the spin terms are tuned off.
- I have checked and corrected the orbit-averaged equations. I checked that they return the circular case for e=0 when the spin effects are turned off. - I corrected the circular functions for converting gwfrequency to pnseparation (and vice versa) to include the spin-induced quadrupole contribution - I have added eccentric functions for converting the semi-major axis to the GW frequency. I leave the user to decide which harmonic to select. The default is 2. - I have added a function for calculating the harmonic at which there is the maximum emission of Gw
I have: - imported explicitly all the functions from precession and added to the __all__ variable ( only way I have found to make all the functions appear in the documentation of precession.eccentricity, and not just those I define explicitly in the eccentrcity.py code. - I have modified the readme -I have added section 4 in the example ( comparison of the same inspiral with and without eccentricity)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Merging @gfumagalli 's eccentric code into master