User Guide

Welcome to epymorph!

This user guide is just one part of a system of documentation which includes demo vignettes and the API reference. These three documents approach epymorph from unique and complementary angles.

• User Guide: a by-feature explanation of epymorph, where each feature is explored in depth,
• Vignettes: example use-cases focusing on specific modeling tasks with epymorph, and
• API Reference: technical information about epymorph’s Python classes and methods.

Although the User Guide is presented as a linear text, we encourage you to wander freely between the three documents as you find each most useful in the moment.

📢 Beta Version!

It’s important to note that epymorph is currently in an open-access beta period. We’re excited for enthusiasts in the community to try epymorph. Your feedback and help road-testing the software is crucial for epymorph’s development.

What does this mean for you? While we believe epymorph has matured to a relatively stable and well-tested software, you should still exercise some caution as befits your use-case. As with any beta software, epymorph may contain bugs we have yet to find and squash. And, although we’ll try to keep this minimal, we may make some non-backwards-compatible changes to the API and feature set between now and the full 1.0 release.

With that said, thank you for your interest in this software into which our team continues to pour so much hard work. We’re glad to have you on board! Questions can be addressed to epymorph@nau.edu and you can track development and submit issues on our Github repository.

📽️ Demo Video

If you’d like to get an idea of what epymorph can do, you can also check out our beta release demo video below.