Aegean
Aegean copied to clipboard
Update API documentation for AegeanTools
The API documentation is incomplete and not easy to navigate/understand. In order for 3rd parties to more easily integrate Aegean into their processing workflows, this API needs to be updated to become more useful.
I'm using the API right now and would be keen to help write some simple docs, if that's of interest to you. No idea if I'm actually using the API "correctly", of course...
Happy to have you contribute to the API documentation. Currently it's auto generated from docstrings and is not very user friendly.
Awesome! What's the intended entry point for use? I'm using source_finder.SourceFinder at the moment.
That would be my recommendation.
aegean-guide.ipynb.zip This is a "basic usage" style notebook that does a minimal application of Aegean to an NVSS field. There's a few gotchas in using the API that I've worked around. Happy to write this up in any format you like if it seems useful, and extend it if need be. Of course there's a bunch of extra functionality I haven't looked at yet.