Developer Documentation

These pages contain the developer documentation. They are aimed at those who are modifying the source code of the project.

Contents:

• Guide to Contributing
• Containerization
• List of Environment Variables
• External Service Dependencies
• Setting Up and Working in the Local Environment
• Use Cases for QA
• DevOps Guide
• Gitlab Ci Job Descriptions
• Code Walkthroughs
• The Job Control Layer
• Modules API

Development of the application is carried out by building and testing the software in three different environments:

• locally at the developer’s workstation.

• at GitLab CI for automated testing.

• remotely at server reflectivity-test.ornl.gov for manual testing, termed environment testenv.

In all cases, building is implemented with containerization of the application in concert with additional containers and services providing the necessary services to successfully run the application, such as a database.