Skip to content

Installation

Requirements

AMPSSIE is a Julia package and runs anywhere Julia is supported.

Operating system: Linux, macOS, and Windows are all supported. Most development and testing has been done on Linux.

Julia version: 1.12 or newer. Earlier releases may work but are not actively tested.

Hardware: A typical desktop or laptop is sufficient for the tutorial problems. For larger 3D problems with refined meshes it is recommended to use an HPC with at least 10 cores, at least 60 GB of RAM and 10 GB of free disk for outputs.

Required tooling:

  • Julia - the language runtime itself.
  • A text editor with JSON support for editing input_data.json files - VS Code with the Julia extension is a sensible default.
  • ParaView or VisIt for visualising the VTU/VTK output.

Optional:

Direct interaction with Julia

The simplest deployment is to install Julia and run AMPSSIE from source.

1. Install Julia. Use the official installer from julialang.org/downloads, or on Linux/macOS use the juliaup toolchain manager:

curl -fsSL https://install.julialang.org | sh

Verify the install with julia --version.

2. Clone the repository.

git clone [insert here]
cd [insert here]

3. Start Julia and install the AMPSSIE package. Open a Julia REPL, change into the MaterialPoints directory of the cloned repository and include the setup script. This installs the exact dependencies recorded in Manifest.toml and starts the parallel workers that AMPSSIE uses:

julia> cd("path/to/AMPSSIE/MaterialPoints")

julia> include("setup_workers.jl")

If everything succeeds the REPL prints the package versions being resolved, the activated project path and a starting sim line; see the Tutorial 1 terminal output (or Tutorial 2) for the expected console.

4. Run a problem. Copy a tutorial input_data.json (for example from Tutorial 1 or Tutorial 2) into the MaterialPoints directory and call the AMPSSIE entry point from the same Julia REPL:

julia> AMPSSIE.run("input_data.json");

This steps through the load increments configured in the JSON and writes .vtu, .vtk and .csv output files to MaterialPoints/src/output. Open the VTU/VTK files in ParaView (or VisIt) to inspect the deformed mesh and the stress / displacement fields.