NatLabRockies / NatLabRockies/OpenStudio

FloorspaceJS is unrecoverable if ${sim}/floorplan.json is missing

Open
#5,599 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Triage
Dominant language
C++
Stars
646
Forks
237
Avg merge
3d 11h
Merged PRs (30d)
10

Description

Description

I have a model whose geometry I can view in 3D view and edit in FloorspaceJS, but if I make a copy or even just rename it I can still see the 3D view but no longer edit; FloorspaceJS simply fails to load.

Current Behavior

The loading bar above FloorspaceJS fills but then nothing happens.

Expected Behavior

I would like to be able to edit my geometry.

Steps to reproduce

This is my model: however, even just you downloading it here is renaming/moving it so I expect you won't be able to see a working good example: in.osm.txt.

  1. Create a basic floor plan
  2. Save it
  3. Run the simulation and verify reports are output
  4. Rename the .osm file
  5. Reload it
  6. Try to edit the floor plan again

https://github.com/user-attachments/assets/e125f6a8-bcac-4d4b-bcda-a02cca6b3eeb

The warning about the weather file is spurious: re-adding the weather file I used doesn't make FloorspaceJS suddenly work, so I'm not going to bother including it (and it's not mine to share either).

Possible Solution

No response

Operating System affected

Ubuntu 24.04

Environment
  • Platform (Operating system, version, architecture): Ubuntu 24.04 x86_64

I got OpenStudio from https://openstudiocoalition.org/app/#/app/releases. Specifically this one.

I am actually running inside a distrobox container inside Arch. I don't know if that has anything to do with the problem.

Version of OpenStudio

3.10.0+86d7e215a1

Context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the reported sequence with the attached in.osm.txt: save a floor plan, run the simulation, rename the .osm file, reload it, and open FloorspaceJS. Trace how the application locates ${sim}/floorplan.json when the model path changes; done means the floor plan editor loads and remains editable after renaming the model.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
desktop
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.