prose intends to be a package for image processing and stops whenever your scientific products are ready.
- fork the github repository
- install prose from your local fork, with
pip install -e {your_local_fork} - Modify the source code, commit and push
- Make a pull request
- commit messages using conventional commits
- black formatting with a 88 characters line limit
- explicit variable name is preferred over comments
- extensive comments
- numpy style docstrings
- tests with pytest
There are few ways to contribute to prose:
- field-specific developments: you want to use prose in a particular field of Astronomy (e.g. develop a new
Blockor new products) - core developments: you want to make changes to prose documentation or its core objects (e.g.
ImageorSequence)
If you want to adapt prose to your own field of Astronomy (e.g. comets, exoplanets, galaxies, space debris... etc) you may want to develop a package using prose rather than making core changes. This is particularly true if you need to develop methods targeting specific products, located after the image processing (see top schematic). Even if being independent in your developments, there are few ways this could contribute to prose, and the community can help.
If you have any question about your application or need support to use prose, open an issue or open a discussion. Describe your idea and potential use cases, so that users familiar with your application can help, but also agnostic contributors. Keep in mind that your idea might be worth making core changes, so users outside of your field can benefit from it.
If you develop tools for a specific field, chances are your developments are worth a separate Python package, so that your community can benefit from your work and cite it.
If working in Academia, we strongly encourage and fully support publishing your work in the Journal of Open Source Software, so that your package can be referenced and cited by others.
Core developments concern changes you want to make on the core objects of prose (e.g. Image, Block and Sequence). These will affect all pipelines written in prose and benefit all sort of applications. Core developments go from fixing a typo in the documentation to integrating new features.
If at the idea stage, feel free to open an issue to discuss about it. If already developed, open a pull request. Whatever stage you are in, try to describe your idea to people not in your field and add a use case and code examples.
We intend to publish an update paper whenever a major version is released and used by the community (in order to showcase nice applications). Making core contributions (fixing typos in the documentation included) is extremely valuable and will make you part of the next paper release (a get you free stickers!).