Skip to content

Command-Line Interface reference

The Nexture application is invoked with the nxt command. Calling it with the --help flag displays the help message:

nxt --help
usage: nxt <command> [<args>]

Available commands:
init       Generate a placement file from the image you want to process (nxt init --help)
synth      Launch a synthesis, using your image and its placement file (nxt synth --help)

 QUICKSTART

 1. Run the following command inside your image's folder, to generate a placement file:

    nxt init <image-filename>

 2. Open the SVG file with Inkscape or Illustrator and define placement.
    (See cronobo.documentation.com on how to do it). Save and close.

 3. Launch the synthesis with this command:

    nxt synth <image-filename> <placement-filename>

 4. Results will appear by default in folder ./nexture_results

positional arguments:
  command     Subcommand to run

optional arguments:
  -h, --help  show this help message and exit

nxt

usage: nxt <command> [<args>]

Available commands:
init       Generate a placement file from the image you want to process (nxt init --help)
synth      Launch a synthesis, using your image and its placement file (nxt synth --help)
check      Checks Nexture install and third-party requirements

optional arguments:
  -h, --help  show this help message and exit

nxt check

Run this command to validate your installation, and get hints about why it might not be working.

nxt check
INFO - Vendor ID         : GenuineIntel
INFO - CPU name          : Intel(R) Core(TM) i5-7440HQ CPU @ 2.80GHz
INFO - Microarchitecture : kabylake
OK  - Your processor supports AVX instructions
OK  - TensorFlow is functional.
OK  - TensorFlow includes GPU support.
OK  - msvcp140.dll found at: c:\windows\system32\msvcp140.dll
OK  - Cuda 9.0 found.
OK  - nvcuda.dll found.
OK  - cudnn64_7.dll found.

Your config is healthy.

nxt init

usage: nxt [-h] img

positional arguments:
  img         Path to the image you want to process

optional arguments:
  -h, --help  show this help message and exit

nxt synth

usage: nxt [-h] [--output-dir RESULT_PREFIX] [--tile-size TILE_SIZE]
           [--num-scales NUM_SCALES] [--min-scale MIN_SCALE]
           [--global-scale GLOBAL_SCALE] [--seed SEED]
           [--iters NUM_ITERATIONS_PER_SCALE] [--subiters NUM_SUBITERATIONS]
           [--coh-weight COH_WEIGHT] [--save-hd-every SAVE_HD_EVERY]
           [--hd-format HD_FORMAT] [--smooth BMAPS_BLUR] [--post-lpf POST_LPF]
           [--post-hpf POST_HPF] [--username USERNAME] [--password PASSWORD]
           image blendmaps

positional arguments:
  image                 Path to image to process
  blendmaps             Blendmap file, generated with npre

optional arguments:
  -h, --help            show this help message and exit
  --output-dir RESULT_PREFIX
                        output folder name prefix, followed by the date of
                        execution
  --tile-size TILE_SIZE
                        Tile size. Can be set to 512 on more powerful GPUs
  --num-scales NUM_SCALES
                        Synthesize with multiple scales
  --min-scale MIN_SCALE
                        Smallest scale. If num-scales is 1, this parameter is
                        set to 1.0
  --global-scale GLOBAL_SCALE
                        Scale factor of samples. Increasing this increases
                        sample size.
  --seed SEED           Seed for the startup image. None creates a new seed
                        each new run
  --iters NUM_ITERATIONS_PER_SCALE
                        Number of iterations per scale
  --subiters NUM_SUBITERATIONS
                        Number of sub-iterations per iteration. You should not
                        need to change this.
  --save-hd-every SAVE_HD_EVERY
                        When to save the HD output (potentially very large
                        image). Should be (tile | iteration | scale | final)
  --hd-format HD_FORMAT
                        Output format for the final post-processed image.
                        Should be (f | i). f: float32 greyscale, i: RGB Uint8
  --smooth BMAPS_BLUR   Smoothing power, to generate smooth transitions
                        between patterns.
  --post-lpf POST_LPF   Postprocess LPF kernel size. Set to 0.0 to disable
  --post-hpf POST_HPF   Postprocess HPF kernel size. Set to 0.0 to disable
  --username USERNAME   Username of your Cronobo Software Licensing account
  --password PASSWORD   Password of your Cronobo Software Licensing account