Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Software/Algorithm developers #13

Closed
4 tasks
sfiruch opened this issue Oct 28, 2021 · 4 comments
Closed
4 tasks

Documentation for Software/Algorithm developers #13

sfiruch opened this issue Oct 28, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation prio-low Low priority

Comments

@sfiruch
Copy link
Member

sfiruch commented Oct 28, 2021

We should make sure that developers on other teams have a smooth entry when they work with our code.

Brief explanations how Karabo can be extended with new

  • Data sets
  • Imaging algorithms
  • Source Detection algorithms
  • RFI/noise simulations
@sfiruch sfiruch added documentation Improvements or additions to documentation prio-low Low priority labels Oct 28, 2021
@sfiruch sfiruch changed the title Provide developer documentation Documentation for Software/Algorithm developers Oct 28, 2021
@sfiruch sfiruch assigned cvoegele and unassigned cvoegele Feb 25, 2022
@Lukas113
Copy link
Collaborator

Lukas113 commented Jan 15, 2024

I think we fulfill the requirements of this issue? Or what do you think @deiruch we should change?

@sfiruch
Copy link
Member Author

sfiruch commented Jan 15, 2024

Yeah, a lot is there. But I think there is still one important piece missing: We should document which functionality can easily be added: Imaging algorithms, RFI simulations, source detection algorithms, new data sets, etc. - with pointers how to start for each one.

I updated the OP accordingly.

@Lukas113
Copy link
Collaborator

I think this is already shown by existing notebooks and should be covered when #583 is taken care of. At least for functions we already provide. Otherwise I would consider it as an API extension issue, not doc. Therefore closed.

@Lukas113 Lukas113 closed this as not planned Won't fix, can't repro, duplicate, stale Aug 26, 2024
@sfiruch
Copy link
Member Author

sfiruch commented Aug 26, 2024

We should reconsider, once we have external devs wanting to extend Karabo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation prio-low Low priority
Projects
None yet
Development

No branches or pull requests

3 participants