mooringDesignSimulator-v2 - Installation

Binary installation

Prebuilt binaries for Windows, Linux, and macOS are available from the shared OneDrive folder:

Download the mooringDesignSimulator-v2 binaries

Download the archive for the target operating system, extract it into a working folder, then run the supplied executable.

Development environment used

The project currently expects a Conda environment named pyside6 and targets Python 3.11.

Main dependencies:

pyside6
qt6-charts
matplotlib
numpy
reportlab
appdirs
toml
xlrd
netcdf4
packaging
pyinstaller
pytest

netcdf4 is required because NetCDF current-profile import is a supported feature.

Create the environment

Create a helper environment with mamba if needed:

conda create -n mambaenv -c conda-forge mamba python=3.11
conda activate mambaenv

Then create the application environment:

mamba env create -f environment.yml
conda activate pyside6

Update an existing environment

mamba env update -n pyside6 -f environment.yml --prune

Run the application

From the activated environment:

python main.py

Or directly with Conda:

conda run --no-capture-output -n pyside6 python main.py

With debug logging:

conda run -n pyside6 python main.py -d -l

Common tasks

If task is installed, the main commands are:

task
task: Available tasks for this project:
  audit-images:       Audit referenced and unreferenced library image files
  build:              Build a standalone executable with PyInstaller
  buildecho:          Build a standalone executable with PyInstaller and output echoed commands
  clean:              Remove Python cache files
  clean-all:          Remove Python caches and PyInstaller build artifacts
  clean-build:        Remove PyInstaller build artifacts and generated spec files
  debug:              Launch the application with debug logging
  default:            Show available tasks
  lib:                Launch the application with the test Excel library
  lint:               Run pylint on the Python entry points
  render:             Launch the standalone render lab on the main Excel library
  res:                Rebuild Qt resources
  run:                Launch the application
  test:               Run the unit test suite

Equivalent abbreviated make commands:

make
Available targets:
  make run           Launch the application
  make debug         Launch the application with debug logging
  make lib           Launch with the test Excel library
  make render        Launch the standalone render lab
  make audit-images  Audit referenced and unreferenced library images
  make test          Run the unit test suite
  make lint          Run pylint on the Python entry points
  make res           Rebuild Qt resources
  make build         Build a standalone executable with PyInstaller
  make buildecho     Build with streamed command output
  make clean         Remove Python cache files
  make clean-build   Remove PyInstaller build artifacts
  make clean-all     Run clean and clean-build

Equivalent direct commands are also possible:

conda run --no-capture-output -n pyside6 python -m unittest discover -v tests
conda run -n pyside6 python -m PyInstaller -wF -c --clean --name mooringDesignSimulator main.py

Previous: Overview | Back to documentation | Back to summary | Next: Usage