Making Sustainable Software for research
FAIR & Open
Phoenix strives to implement FAIR principles and open-source and free software
- Findable: Phoenix is publicly available on the IN2P3 GitLab instance and Zenodo.
- Accessible: The software can be cloned from GitLab ; releases versions can be download from GitLab releases or Zenodo. Documentation is included in the source code and publicly hosted with gitlab pages. Phoenix packages are available on public conda channels hosted at prefix.dev.
- Interoperable: Phoenix is packaged in the conda format which supports many platforms and operating systems and allowing easy installation for users without administrative rights. pixi tasks automatize environment creation and running development tasks.
- Reusable: Phoenix's modular design allows users to easily reuse any library. Dependencies are managed using pixi, enabling the creation of reproducible environments described in lock files.
Phoenix is licensed under the CeCILL-C license, granting users the freedom to copy, modify, and distribute the software.
Building documentation
The main entrypoint to phoenix documentation is available via gitlab pages. Each repository also contains a README and a dedicated documentation page hosted with gitlab pages as well as documented tests. All phoenix projects should have a detailed documentation for both users and developers of the libraries, including the API documentation generated from the code. Unfortunately, the current content of the documentation is lacking for some projects, and the maintainers are working to improve the situation. Until the situation improves, users are welcome to reach out to the maintainer to get the missing information.
Long term evolution and maintenance
Phoenix is maintained by permanent engineers and researchers at LAPP who commit to long-term support of research experiment software. Phoenix is sustained by a core team of software research engineers at LAPP, who are committed to its long-term maintenance and development. There are currently no threats to its continued development, which is actively progressing. In addition to the core team, additional developers can be funded by other sources, as is currently the case with the OSCARS Starlight project.