Troubleshooting
Most problems say what to do where they happen: a bundle's check lists each fatal finding with its remedy, and a job that fails says what went wrong. The rest are here.
The window
- The window does not open:
situcraft --window browseruses your default browser instead;--window noneprints the address to open yourself. - "Start SituCraft with its program": the page was opened without SituCraft running; run
situcraft. - The Viewer needs WebGL2, which current Chrome, Edge, Firefox and Safari have.
- Its port is taken: SituCraft uses the next free port up to 8859, or the one you give with
--port.
Bundles and jobs
- A bundle will not open: the Data view lists each fatal finding with its remedy (Check it).
- A bundle moved: Locate… in the Data view points the project to its new place (Projects).
- A job was interrupted (SituCraft or the computer stopped): it is shown as interrupted when SituCraft starts again; Resume continues it where it stopped (Jobs).
- A refinement will not fit: the studio's Compute step says what it needs against what the computer has, and refuses a run past the computer's memory. Refine a region, or use the Low memory preset (Refinement; what it needs).
- The cache grows: derived data are kept within
--cache-limit(10 GB unless you say), removing what was used least recently, and can be deleted at any time: they are built again when needed.
Command-line options
| Flag | Default | What it does |
|---|---|---|
--port | 8840 | Preferred port; the next free one up to 8859 is used if it is taken |
--window | app | app (a desktop window), browser (the default browser) or none |
--keep-running | off | Keep serving after the window is closed |
--data-dir | <user config dir>/SituCraft | Where the project library is kept |
--cache-dir | <user cache dir>/situcraft | Where derived data go (image tiles, transcript indexes, tiled outlines, a zipped bundle's unpacked members); can be deleted at any time |
--cache-limit | 10GB | The size the cache is kept within, removing what was used least recently (500MB, 20GB; 0 for no limit) |
--examples-dir | <data dir>/examples | Where example datasets are downloaded, when you ask |
--remote-control | off | Let programs on this computer drive the window (Remote control) |
--host | 127.0.0.1 | Interface to bind |
--version | Print situcraft X.Y.Z and exit |
Research use
SituCraft is for research use only. It is not a medical device and makes no diagnostic claims.
Something else? Open an issue with what you did, what you expected and what happened; the drawer's log (⌘J) says what SituCraft did.