POptUS Python package

POptUS is a Python package that provides infrastructure and common code that could be used by other Python packages within the POptUS universe.

Note

This is being developed as an alpha version. While all functionality offered officially is under test, the code and test suite are still under active development. In addition, the interface of the package will likely undergo significant changes as we work toward the first official release.

We have identified two different types of people who might interface with the POptUS package:

1. Users of Python code (such as methods, models, & applications) that were implemented using the POptUS package’s infrastructure.

2. Developers of Python code (such as methods, models, & applications) that would like to use the POptUS package’s infrastructure in their codes.

In terms of documentation, the needs and interests of those two groups can be substantially different. In such cases the User Guide is structured to present information for each group in a different subsection whose name clearly indicates the target user.

User Guide:

• 1. Getting Started
• 2. Logging
• 3. Programmatic Interface

Developer Guide:

• 1. Contributing
• 2. Developer Environment
• 3. Documentation
• 4. Advanced Programmatic Interface

Readers interested in studying examples should refer to the POptUS Jupyter book.