📘 User Guide Overview¶
Welcome to the AFCCP User Guide — a hands-on tutorial series designed to help users explore and understand the core functionality of the Air Force Cadet Career Problem (AFCCP) module.
This guide is ideal for new users looking to get up and running, as well as experienced users seeking to deepen their understanding of how parameters, value functions, and model logic interact.
📚 Tutorial Series Overview¶
✅ Tutorial 1: Introduction¶
Learn how to set up the AFCCP environment and run your first model. This tutorial covers:
- How to clone the repository and install dependencies
- What to expect when running main.py
- A basic walkthrough of the instance/ data folder and outputs
✅ Tutorial 2: Data Overview¶
Dive into the data that power the AFCCP model. You’ll learn:
✅ Tutorial 3: Parameters¶
Explore the parameters dictionary and get to know all the underlying data represented by it.
✅ Tutorial 4: Value Parameters¶
Learn how the weights/values/constraints are structured within the value_parameters dictionary.
✅ Tutorial 5: Data Methods¶
Discover the various CadetCareerProblem methods used to correct the data for specific purposes.
✅ Tutorial 6: Solutions Overview¶
Get a basic understanding of how the solutions are processed in afccp.
✅ Tutorial 7: Algorithms¶
This tutorial dives into the algorithms and meta-heuristics available to the CadetCareerProblem class.
✅ Tutorial 8: Optimization¶
Learn the different optimization models, along with some sensitivity analysis, available within this module.
✅ Tutorial 9: Visualizations¶
Explore the many kinds of visualizations available to the CadetCareerProblem class.
🧠 Who Should Use This Guide?¶
- Cadet assignment modelers looking to experiment with AFSC match logic
- Researchers interested in operations research applications in workforce planning
- Developers wanting to understand or extend the
afccpPython codebase
🚀 Let’s Get Started¶
Continue to Tutorial 1 to launch your first AFCCP model and start exploring how it all fits together.
Happy modeling!