Quick Start Guides

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?

┌─────────────────────────────────────────────────────────────┐
│  "I want to try NeqSim right now without installing anything"│
│  ➜ Google Colab Quickstart                                   │
├─────────────────────────────────────────────────────────────┤
│  "I'm a Python user / data scientist"                        │
│  ➜ Python Quickstart                                         │
├─────────────────────────────────────────────────────────────┤
│  "I'm building a production application"                     │
│  ➜ Java Quickstart                                           │
├─────────────────────────────────────────────────────────────┤
│  "I want to extend or contribute to NeqSim"                  │
│  ➜ Java Quickstart + Developer Setup                         │
└─────────────────────────────────────────────────────────────┘

After the Quickstart

Once you’ve completed a quickstart, continue with:

  1. Learning Paths - Structured tutorials for your role
  2. Cookbook - Quick recipes for common tasks
  3. Reading Fluid Properties - Understanding init levels and property access
  4. Examples - Jupyter notebooks and Java examples

API Reference