A repository for the ATHENA proton response files produced within the AHEAD2020 · Horizon 2020 Research and Innovation Programme · GA 871158 WP 9.3.c "Understanding the interaction between soft protons and X-ray mirrors"
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
</p>
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://www.ict.inaf.it/gitlab/proton_response_matrix/athena-proton-response-files/-/settings/integrations)
## Collaborate with your team
<!-- ABOUT THE PROJECT -->
## About The Project
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-[ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
AHEAD2020 · Horizon 2020 Research and Innovation Programme · GA 871158
WP 9.3.c "Understanding the interaction between soft protons and X-ray mirrors"
## Test and Deploy
* Authors: V.Fioretti(1), T. Mineo(2), R. Amato(2), S. Lotti(3), C. Macculi(3), S. Molendi(4), F. Gastaldello(4), M. Cappi(1), M. Dadina(1), S. Ettori(1)
Use the built-in continuous integration in GitLab.
* Description: The proton response matrix for the ATHENA telescope is composed by a Redistribution Matrix File (RMF)
mapping the proton energy space (from 2 to 300 keV) into detector pulse height and an Auxiliary Response File (ARF)
collecting the grasp of the optics, the filter transmission efficiency and the detector quantum efficiency. A PATTERN selection of 0 (only events that generate 1 pixel or Singles counts) is used following the XMM-Newton EPIC definition.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
* The files are formatted according to the NASA OGIP (Office of Guest Investigators Program) calibration database (caldb) format, and they are tested with the NASA HEASARC XSPEC analysis software tool.
***
### Built with
The current release of the proton response files is based on:
* Geant4 v10.4 [Agostinelli et al. NIMPA, 506, 250, 2003; Allison et al. ITNS, 53, 270, 2006; Allison et al. NIMPA, 835, 186, 2016]
* BoGEMMS v2.1 [Fioretti et al., Proc. SPIE, 118221F, 2021]
* Ray-tracing Monte Carlo code [Mineo et al., Exp. Astr., 44, 287, 2017]
* ATHENA WFI and X-IFU Geant4 mass models provided by the ATHENA Instrument Consortia (2022 design)
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
<!-- USAGE -->
## Usage
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
* The RMF and ARF files can be loaded with any X-ray analysis software compliant with the NASA caldb format.
* Since the accuracy of the Geant4 modeling of the proton stopping power degrades below 1 keV (20% at 1 keV reported in the Geant4 Physics Reference Manual), the energy redistribution is modelled from 1 keV to the upper threshold of the instrument X-ray RMF.
* Validity energy range: due to biases at the boundary of the RMF modeling, induced by features in the interpolation because of limited statistics in the simulation, the spectral analysis must be performed within the following intervals:
* WFI: 1.5 - 12 keV
* X-IFU: 1.5 - 7 keV (the limited upper energy threshold is due to the lower statistics achieved in the X-IFU Geant4 simulations because of the intrinsic lower soft proton induced background flux)
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
<!-- LICENSE -->
## License
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
* Copyright (C) 2022 INAF - see LICENSE.rst
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
<!-- CONTACT -->
## Contact
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
The research leading to these results has received funding from the European Union’s Horizon 2020 Programme under the AHEAD2020 project (grant agreement n. 871158).
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
