Get up and running with NeqSim in 5 minutes. Choose your platform:
Documentation Version: These guides are for NeqSim 3.x. Check the Maven Central page for the latest version number.
| Platform | Best For | Time to First Calculation |
|---|---|---|
| Java Quickstart | Production applications, full API access | ~10 minutes |
| Python Quickstart | Data science, scripting, Jupyter notebooks | ~5 minutes |
| Google Colab | No installation, instant start | ~1 minute |
Which Should I Choose?
| Goal | Recommended path |
|---|---|
| Try NeqSim immediately without installing anything | Google Colab Quickstart |
| Use NeqSim from Python, data-science tools, or notebooks | Python Quickstart |
| Build a production Java application with full API access | Java Quickstart |
| Extend NeqSim or contribute to the repository | Java Quickstart and Developer Setup |
| Use AI agents to solve and document an engineering problem | Solve an Engineering Task |
After the Quickstart
Once you’ve completed a quickstart, continue with:
- Learning Paths - Structured tutorials for your role
- Solve an Engineering Task - Let AI agents run simulations, validate results, and generate reports
- Cookbook - Quick recipes for common tasks
- Reading Fluid Properties - Understanding init levels and property access
- Examples - Jupyter notebooks and Java examples
API Reference
- JavaDoc API Reference - Complete Java API documentation
- Reference Manual - Comprehensive documentation index