OpenSite/File formats

From BathAfrica Documentation
Revision as of 15:09, 29 October 2026 by BathAfrica (talk | contribs) (Complete OpenSite user manual, tutorial pathways and support navigation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
OpenSite 0.0.1 · DevelopmentSource scope and availability

Know what is stored in each kind of file.

Files at a glance

File/data Purpose Important boundary
.osdoc Engineering document, versioned JSON model The current writer uses format 4. Session undo history, script editors and plot tabs are not a project backup.
.py Saved Python script UTF-8 text; executes trusted code in the chosen host.
opensite-material-exchange version 1 Material import/export payload Not a full document or model conversion format.
settings.json / opensite-settings version 1 User/presentation settings where configured Separate from credentials and from a complete engineering file.
.png Saved plot/viewport image An image, not editable model data or calculation verification.

Compatibility

The reviewed writer emits document format 4. Formats 1–3 load; format 5 and newer are rejected. Earlier OpenSite builds do not read format 4. Keep an original copy before opening and saving with a newer build.

What a document does not guarantee

An unavailable plugin payload can be preserved without computation support. Cross-document links require matching identities and recovery uses open documents. A saved file does not prove that Python ran, that all links resolved or that engineering results were independently checked.

Safe working practice

Use OpenSite/Guides/Manage document files and OpenSite/Guides/Update OpenSite. Do not rename an arbitrary JSON, spreadsheet, CAD or solver file to .osdoc and expect an import workflow.