Aegean icon indicating copy to clipboard operation
Aegean copied to clipboard

Update API documentation for AegeanTools

Open PaulHancock opened this issue 5 years ago • 5 comments

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.

PaulHancock avatar Jul 12 '19 00:07 PaulHancock

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...

MatthewJA avatar Jul 31 '19 12:07 MatthewJA

Happy to have you contribute to the API documentation. Currently it's auto generated from docstrings and is not very user friendly.

PaulHancock avatar Aug 05 '19 11:08 PaulHancock

Awesome! What's the intended entry point for use? I'm using source_finder.SourceFinder at the moment.

MatthewJA avatar Aug 05 '19 11:08 MatthewJA

That would be my recommendation.

PaulHancock avatar Aug 05 '19 11:08 PaulHancock

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.

MatthewJA avatar Aug 10 '19 05:08 MatthewJA