To ensure that your project and repository is stable from the very start there are a few todo items that you should take care of. Unfortunately the RAIL project template can not do these for you, otherwise it would :)
- In your repository settings:
- Grant the
LSSTDESC/rail_admingroup administrator access - Grant the
LSSTDESC/photo-zgroup maintainer access
- Grant the
- Configure Codecov for the repository
- Go here, https://github.com/apps/codecov, click the "Configure" button
- Log in to PyPI.org and configure Trusted Publishing following these instructions https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/
- Create a Personal Access Token (PAT) to automatically add issues to the RAIL project tracker
- Follow these instruction to create a PAT: https://github.com/actions/add-to-project#creating-a-pat-and-adding-it-to-your-repository
- Save your new PAT as a repository secret named
ADD_TO_PROJECT_PAT
- Make sure your
mainbranch is protected - Update this README
- Create an example notebook
- Run
pylinton your code - Remove this TODO list once all items are completed
This package is part of the larger ecosystem of Photometric Redshifts in RAIL.
This code, while public on GitHub, has not yet been released by DESC and is still under active development. Our release of v1.0 will be accompanied by a journal paper describing the development and validation of RAIL.
If you make use of the ideas or software in RAIL, please cite the repository https://github.com/LSSTDESC/RAIL. You are welcome to re-use the code, which is open source and available under terms consistent with the MIT license.
External contributors and DESC members wishing to use RAIL for non-DESC projects should consult with the Photometric Redshifts (PZ) Working Group conveners, ideally before the work has started, but definitely before any publication or posting of the work to the arXiv.
If you use this package, you should also cite the appropriate papers for each code used. A list of such codes is included in the Citing RAIL section of the main RAIL Read The Docs page.