User Support

Code Repository

Source code is contained within an open, authoritative repository infrastructure managed by dedicated staff and based on Git and the associated cloud-based GitHub. Git is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files. As such, it provides the infrastructure essential for community involvement in the development and the progression of software from concept through acceptance into operations.

Repositories exist for umbrella applications and different components. Each component repository will contain the source code for a unique component of the UFS application. The umbrella repository will contain the policies, documentation, configurations, and testing protocol required to link to the individual component repositories, which, when brought together, define a given UFS application. The UFS Repository Management Plan provides one example of such a repository governance.

Blurred out, multicolored code on computer screen
Six professionals with laptops and papers gathered around a table discussing their work

User Forums
& Training Opportunities

EPIC teams will staff a central communication forum for answering questions. They will also update a troubleshooting page on a regular basis. The primary focus of this service will be to ensure access and usability by all community members, regardless of the level of expertise.

Additionally, EPIC will establish routine in-person user-focused workshops and sessions at meetings, such as the American Meteorological Society (AMS) and American Geophysical Union (AGU) annual conferences. As the community grows, EPIC will consider developing Massive Online Open Courses (MOOCs).

Documentation

Comprehensive code and science-based documentation is essential for UFS usability. EPIC will deliver a comprehensive set of documentation that supports researchers’ and developers’ understanding of UFS code and its underlying science. The documentation will be maintained dynamically by both the user community and EPIC support staff to ensure that it stays up-to-date as the code is updated or revised.

EPIC’s documentation will enable the community to grow, teach themselves, and foster a more collaborative approach to code development. The documentation will address core technology capabilities, including code management and version control; testing and verification packages and protocols; and software engineering best practices that will be enforced to ensure model code portability to a variety of computing platforms.

To help introduce users to the system, regularly scheduled user tutorials and workshops (both in-person and online) will be provided by EPIC, particularly during the first years of the program.

Laptop computer with icons of file folders and documents floating above the keyboard to illustrate documentation the laptop user is editing.

EPIC AWS Costs

AWS Services: c5.xlarge, EC2, Image Builder, S3

Three students sit at computer lab stations to complete work.

User Tutorials

Coming Soon! 

See the UFS Knowledge Base for UFS Community tutorials.