Skip to content

Commit

Permalink
Update README to mention the implied default compartment
Browse files Browse the repository at this point in the history
Describes the change proposed in #26.
  • Loading branch information
ma3ke committed May 30, 2024
1 parent 0443e4a commit 4673fca
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,30 @@ at 50 nm.

</details>

<details>
<summary>Implied default compartment.</summary>

If you omit the `"compartments"` field from the `"space"` section, and don't
set the `"compartments"` field in any of the segments in the `"segments"`
section, a single default compartment is implied.
This compartment is set up like this.

```json
{
"id": "main",
"shape": "cuboid"
}
```

Each segment, when the compartment is implied, is assigned to that `"main"`
compartment.

Note that when the `"compartments"` field on any segment is not set, its
compartment id will be set to `"main"`, even when a compartment is defined in
the `"space"` section.

</details>

#### Output

In **output**, we set a **title** and **dir**ectory to write the placement list
Expand Down

0 comments on commit 4673fca

Please sign in to comment.