girder-flycut-studio 1.0.3__tar.gz

girder_flycut_studio-1.0.3/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2026, Max Berner and contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of girder-flycut-studio nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

girder_flycut_studio-1.0.3/MANIFEST.in

@@ -0,0 +1,11 @@
+include README.md
+include LICENSE
+exclude .eslintrc.* CLAUDE.md requirements.txt requirements-dev.txt ruff.toml package-lock.json package.json
+recursive-include girder_flycut *.py *.json *.lbrn2
+prune girder_flycut/web_client
+include girder_flycut/web_client/dist/girder-plugin-flycut.umd.cjs
+include girder_flycut/web_client/dist/style.css
+recursive-include tests *.py *.cjs *.mjs
+prune test
+
+recursive-include docs *.md

girder_flycut_studio-1.0.3/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: girder-flycut-studio
+Version: 1.0.3
+Summary: Flyer Studio configuration, generation, and IGSN registration for Girder
+Home-page: https://github.com/htmdec/girder-flycut-studio
+Author: Max Berner
+Author-email: bernermaximus@gmail.com
+Maintainer: Kacper Kowalik
+Maintainer-email: xarthisius.kk@gmail.com
+License: BSD-3-Clause
+Project-URL: Source, https://github.com/htmdec/girder-flycut-studio
+Project-URL: Issues, https://github.com/htmdec/girder-flycut-studio/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: girder-dashboards>=0.2.0
+Requires-Dist: girder-jsonforms>=2.1.1
+Requires-Dist: redis
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# girder-flyer-studio
+
+A girder dashboard developed for use with [girder dashboards](https://github.com/Xarthisius/girder-dashboards/tree/main), [girder jsonforms](https://github.com/Xarthisius/girder-jsonforms/), and [LightBurn Software](https://lightburnsoftware.com/).
+
+Facilitates the specification, creation, and registration of **Flyer Stacks**, which are an array of small circular discs used in laser impact experiments. This is accomplished through automatic specification of templated LightBurn project files through a simplified JSON form, packaging and capture of experimentally relevant metadata, and IGSN registration per flyer stack on girder.
+
+## Features
+
+- Draft → submitted → generated → registered lifecycle.
+- LightBurn layout, inventory CSV, and JSON metadata generation.
+- Scans girder for foil IGSNs (denoting base material) by contains alternative identifier `foil-igsn`.
+- Registration creates `<foil IGSN>-<stack ID>` as a child deposition using JSONForms. 
+- Metadata and experiment invariants validated. 
+
+## Admin settings and shared storage
+
+See [Configuration form validation](docs/CONFIGURATION_FORM_VALIDATION.md) for form requirements, acknowledgement rules, and downstream checks.
+
+See [Dashboard configuration](docs/DASHBOARD_CONFIGURATION.md) for administrator setup instructions, a complete settings example, permissions, and the Complete Workflow module.
+
+## Offline drafts
+
+Use **Copy** or **Download** in the JSON tab to export the current form, including
+incomplete configurations. Upload a single configuration `.json` file per item
+directly into the workspace's **Drafts** folder using Girder's file browser, then
+refresh the studio's configuration list. The studio creates this folder when the
+list is opened by an operator with workspace write access.
+
+Matching JSON in either the current section format or the legacy builder format
+appears as an editable, unvalidated draft. Imported drafts must still be submitted
+through the form's normal validation before generating or registering a stack.
+Malformed or unrelated JSON remains in the upload folder. Files must be no larger
+than 256 KiB, and the operator must have write access to import them.
+
+## Authors and licence
+
+Flyer Studio was written by [Max Berner](https://github.com/mxberner). The conversion to a
+conventional Girder 5 plugin is by [Kacper Kowalik](https://github.com/Xarthisius).
+
+Released under the [BSD 3-Clause licence](LICENSE).

girder_flycut_studio-1.0.3/README.md

@@ -0,0 +1,40 @@
+# girder-flyer-studio
+
+A girder dashboard developed for use with [girder dashboards](https://github.com/Xarthisius/girder-dashboards/tree/main), [girder jsonforms](https://github.com/Xarthisius/girder-jsonforms/), and [LightBurn Software](https://lightburnsoftware.com/).
+
+Facilitates the specification, creation, and registration of **Flyer Stacks**, which are an array of small circular discs used in laser impact experiments. This is accomplished through automatic specification of templated LightBurn project files through a simplified JSON form, packaging and capture of experimentally relevant metadata, and IGSN registration per flyer stack on girder.
+
+## Features
+
+- Draft → submitted → generated → registered lifecycle.
+- LightBurn layout, inventory CSV, and JSON metadata generation.
+- Scans girder for foil IGSNs (denoting base material) by contains alternative identifier `foil-igsn`.
+- Registration creates `<foil IGSN>-<stack ID>` as a child deposition using JSONForms. 
+- Metadata and experiment invariants validated. 
+
+## Admin settings and shared storage
+
+See [Configuration form validation](docs/CONFIGURATION_FORM_VALIDATION.md) for form requirements, acknowledgement rules, and downstream checks.
+
+See [Dashboard configuration](docs/DASHBOARD_CONFIGURATION.md) for administrator setup instructions, a complete settings example, permissions, and the Complete Workflow module.
+
+## Offline drafts
+
+Use **Copy** or **Download** in the JSON tab to export the current form, including
+incomplete configurations. Upload a single configuration `.json` file per item
+directly into the workspace's **Drafts** folder using Girder's file browser, then
+refresh the studio's configuration list. The studio creates this folder when the
+list is opened by an operator with workspace write access.
+
+Matching JSON in either the current section format or the legacy builder format
+appears as an editable, unvalidated draft. Imported drafts must still be submitted
+through the form's normal validation before generating or registering a stack.
+Malformed or unrelated JSON remains in the upload folder. Files must be no larger
+than 256 KiB, and the operator must have write access to import them.
+
+## Authors and licence
+
+Flyer Studio was written by [Max Berner](https://github.com/mxberner). The conversion to a
+conventional Girder 5 plugin is by [Kacper Kowalik](https://github.com/Xarthisius).
+
+Released under the [BSD 3-Clause licence](LICENSE).

girder_flycut_studio-1.0.3/docs/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 1.0.3
+
+- Publish under the requested PyPI distribution name girder-flycut-studio.
+
+## 1.0.2
+
+- Remove the unsupported Girder classifier rejected by PyPI during the 1.0.1 upload.
+
+## 1.0.1
+
+- Import offline JSON configurations from the workspace Drafts folder.
+- Copy and download incomplete configurations without validation.
+- Disable Stack ID autocomplete and fix configuration tooltips.
+- Keep generated metadata fields free of duplicated configuration JSON.
+- Correct the PyPI project link and create the GitHub release during publishing.
+
+## 1.0.0
+
+Initial standalone source release of Flyer Studio for Girder.
+
+- Configuration, generation, registration, and Complete Workflow modules (1-3).
+  - Configuration of JSON run-script through on portal JSON form, complete with data validation.
+  - Generation of "stack identity". 
+  - `stack-metadata` holding stack relevant metadata. 
+  - `stack-layout` holding automatically configured lightburn project file. 
+  - `stack-inventory` holding live flyer inventorying data for future visualization and management. 
+- Dashboard-admin settings for dashboard configuration.
+- Generated lightburn files pass on their capacity to function as a template. 

girder_flycut_studio-1.0.3/docs/CONFIGURATION_FORM_VALIDATION.md

@@ -0,0 +1,168 @@
+# Configuration form: requirements and validation
+
+This describes the current **01 Configuration** form, also used by **1–3 Complete
+Workflow**. It distinguishes submission requirements from warnings and later
+server checks. It documents implemented behavior, not additional desired rules.
+
+## Drafts and workflow entry
+
+- **Save** stores a draft; it does not require a complete form or acknowledgement
+  of warnings. A draft may have an empty Stack ID and no material/template.
+- **Copy** and **Download** in the JSON tab export the current form without
+  requiring completion or warning acknowledgement. Uploads into the workspace
+  **Drafts** folder are discovered when the configuration list refreshes and
+  remain unvalidated until submitted. See [offline drafts](../README.md#offline-drafts).
+- Saved JSON must be an object no larger than 256 KiB and contain no non-finite
+  JSON numbers. The optional “Save as” name is limited to 160 characters.
+- A blank draft name becomes `stack<ID>-config` when an ID is present, otherwise
+  `Untitled draft`. Submitted names always become `stack<ID>-config`.
+- Submitted, generated, and registered configurations are read-only. The ordinary
+  Configuration module permits viewing them and editing a copy.
+- Complete Workflow permits **New configuration** or an **editable draft** only.
+  It excludes submitted, generated, registered, and read-only draft records.
+- Saving/updating requires the configured workspace and appropriate Write access.
+  Existing drafts must belong to that workspace. The dashboard must be enabled
+  and readable, and the user must be signed in.
+
+## Blocking requirements before submission
+
+| Field or condition | Requirement |
+| --- | --- |
+| Stack ID | Required: `F###`, `F####`, or exactly five uppercase Crockford Base32 characters (`0123456789ABCDEFGHJKMNPQRSTVWXYZ`), after trimming whitespace. Cannot be bypassed by acknowledgement. |
+| Foil material | Select a foil from the readable Girder foil catalog. The server resolves and validates the selection. |
+| Template | Select a valid catalog or accessible portal template. |
+| Laser settings | Enable at least one entry. |
+| Custom fields | Every row with a nonblank value must have a nonblank name. Completely blank rows are ignored. |
+| Registered Stack ID | Cannot be reused. |
+| Generated Stack ID | Generated files must be deleted before reusing the ID. |
+| Restricted Stack ID | Cannot replace a configuration outside the workspace or without Write access. |
+
+Stack identity is checked again on submission. Concurrent changes can therefore
+reject a submission even if the page previously showed it as available. An
+unrelated folder already occupying the destination stack folder also blocks
+submission. Existing submitted configurations can be replaced only after explicit
+validation acknowledgement and with Write access.
+
+Presets are disabled and hidden. Their required-field checks are inactive in the
+current dashboard; submitted configurations store `preset: null`.
+
+## Warnings requiring acknowledgement
+
+A complete form displays **Needs validation** for any of these conditions:
+
+1. The Stack ID already has a submitted configuration; submission will replace it.
+2. Operator is blank; the current user's login is used as a fallback.
+3. Any enabled laser entry still carries the default-parameters marker.
+4. Some template layers have no enabled assigned setting; their original template
+   laser parameters will remain.
+5. Any listed laser entry is disabled or unused by the chosen template.
+6. A named custom field has no value; it exports as JSON `null`.
+
+Open **Status**, review the listed issues, and check the validation acknowledgement
+before submitting. Missing blocking requirements cannot be acknowledged away.
+Form edits clear acknowledgement; it applies only to the configuration reviewed.
+The server independently checks warnings and requires the acknowledgement flag.
+
+Status meanings:
+
+| Status | Meaning |
+| --- | --- |
+| Incomplete | At least one blocking requirement is missing. |
+| Needs validation | Blocking requirements pass, but warnings need acknowledgement. |
+| Validated | Warnings have been acknowledged for the current form contents. |
+| Complete | Blocking requirements pass and there are no warnings. |
+| Submitted / Generated / Registered | Saved lifecycle state shown for read-only records. |
+
+“Complete” is not a guarantee that later generation or registration will succeed.
+
+## Laser controls and assignment
+
+The form allows up to 28 entries, named sequentially `F1` through `F28`. The last
+remaining entry cannot be removed, but disabling all entries blocks submission.
+Reordering changes the assignment order. Imported settings are initially locked.
+Colors must be unique six-digit hex values such as `#3C8D40`; an invalid or duplicate
+color is rejected by the color editor and independently during generation.
+
+| Control | Declared browser input limits | Generation server checks |
+| --- | --- | --- |
+| Power (%) | 0–100; step 0.1 | Finite number ≥ 0; no upper-bound check. |
+| Speed (mm/s) | ≥ 0.01; step 0.01 | Finite number ≥ 0. |
+| QPulse (ns) | ≥ 0; step 1 | Finite number ≥ 0; no integer-only check. |
+| Frequency (kHz) | ≥ 0; step 0.1 | Finite number ≥ 0. |
+| Passes | ≥ 1; step 1 | Positive integer. |
+| Repeat | Integer 1–10000 | Integer 1–10000, checked during submission and generation. |
+| Wraparound | Checkbox | Boolean. |
+
+The form uses custom validation with native form validation disabled. Numeric HTML
+limits above are input guidance, **not all enforced submission rules**. Server
+numeric laser validation happens during generation. The server also requires
+1–28 laser entries and boolean `enabled` values. Legacy disabled entries may retain
+null numeric values; enabled entries must have valid numbers.
+
+Repeat assigns each entry to that many successive template layers. Wraparound
+cycles through the entries when needed. Disabled entries still occupy positions.
+Uncovered layers retain their template settings rather than stopping submission;
+unused/disabled entries and uncovered layers produce the warnings listed above.
+
+## Custom fields and special values
+
+- Field names are trimmed when exported. Values are retained as strings; blank
+  values become `null`. There is no general required list while presets are disabled.
+- Duplicate field names are not rejected: the last row with that trimmed name wins
+  in the exported object. This is current behavior, not a uniqueness guarantee.
+- `test_run` is checked by the server at submission. Accepted true values are
+  `true`, `yes`, `1`, `on`; false values are `false`, `no`, `0`, `off`
+  (case-insensitive, surrounding whitespace ignored). An omitted, null, or empty
+  value means false. Other values are rejected.
+- Thickness is not required or resolved during generation. Any supplied thickness
+  custom fields are preserved as ordinary custom fields; generated metadata omits
+  the thickness section and material thickness.
+
+## Additional generation checks
+
+Generation checks the submitted configuration again, including:
+
+- Stack ID length 1–120, no `/` or `\`, and no characters with code point below 32.
+  Thus an acknowledged unusual ID may submit but still fail generation.
+- Foil/template still present and accessible; valid laser settings and assignment.
+- Custom fields form a named mapping whose values are strings, numbers, or null.
+- Template structure contains the referenced cut settings and expected stack-ID
+  placeholder; resolved thickness values are positive.
+- Configuration is submitted, belongs to the workspace, and is writable. Another
+  generated/registered configuration cannot reserve the same Stack ID.
+
+## Imports and portal templates
+
+- JSON import must parse as configuration JSON. The import reads at most 28 laser
+  entries. Importing does not bypass submission or generation checks.
+- Excel import accepts an `.xlsx` workbook, 1 byte–5 MiB, with at most 30 MiB of
+  declared expanded ZIP content. Only the first worksheet is read.
+- The first worksheet needs headers for `power` (or `maxpower`), `speed`,
+  `qpulsewidth`, `frequency`, and `passes` (or `numpasses`). Headers are trimmed
+  and case-insensitive. It must contain at least one parameter row. Completely
+  empty rows are skipped; at most 28 rows are imported. Numeric validity is checked
+  later during generation.
+- A portal template must be accessible and identify a LightBurn file. If its item
+  contains multiple candidate files, an exact filename is required. Template
+  parsing/identity checks can reject unsupported or malformed files.
+
+## Complete Workflow
+
+The same submission requirements and acknowledgement apply to **Submit, generate
+& register**. It then runs generation and registration in order. Draft saving never
+triggers those stages. Keep the page open until completion. A failed stage preserves
+saved work and opens Generation or Registration for recovery; it does not undo the
+successful earlier stages. Registration additionally requires generated files,
+Write access to the parent foil and output items, valid creator settings, and an
+available stack IGSN. These are registration requirements, not form status checks.
+
+## Implementation references
+
+- `girder_flycut/web_client/core/assess.js`: the requirements and the six warnings.
+- `girder_flycut/web_client/core/validate.js`: the export gate and the status label.
+- `girder_flycut/web_client/views/StatusPanelView.js`: how both are reported.
+- `girder_flycut/client_wrapper.js`: draft saving, submission, and workflow selection.
+- `girder_flycut/validation.py`: server normalization, warnings, and generation validation.
+- `girder_flycut/rest.py`: access, lifecycle, size limits, and submission endpoints.
+- `girder_flycut/registration.py`, `generate.py`, `engine.py`, `excel.py`: special fields
+  and downstream checks.