rhylthyme 0.1.0__tar.gz

rhylthyme-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Jeremy Leipzig
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rhylthyme-0.1.0/PKG-INFO

@@ -0,0 +1,330 @@
+Metadata-Version: 2.4
+Name: rhylthyme
+Version: 0.1.0
+Summary: A tool for working with real-time program schedules
+Author-email: Leipzig <hello@example.com>
+Project-URL: Homepage, https://github.com/yourname/rhylthyme
+Project-URL: Bug Tracker, https://github.com/yourname/rhylthyme/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema>=4.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: marimo>=0.2.0
+Requires-Dist: pandas>=1.0.0
+Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: pytest>=7.0.0
+Requires-Dist: pytest-cov>=4.0.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: flask>=2.0.0
+Requires-Dist: flask-cors>=4.0.0
+Dynamic: license-file
+
+# Rhylthyme
+
+🕒 **rhylthyme** (pronounced "realtime") is a JSON-based workflow language for describing and executing real-time event scheduling.
+
+---
+
+## 🚀 Quick Start
+
+### American Breakfast Example
+
+Here's a simple program that coordinates cooking eggs, bacon, and toast to finish at the same time:
+
+```bash
+# Navigate to the CLI runner directory
+cd rhylthyme-cli-runner
+
+# Validate the breakfast program
+python -m rhylthyme_cli_runner.cli validate ../rhylthyme-examples/programs/breakfast_schedule.json
+
+# Run the breakfast program
+python -m rhylthyme_cli_runner.cli run ../rhylthyme-examples/programs/breakfast_schedule.json
+```
+
+---
+
+## 💫 What is Rhylthyme?
+
+Rhylthyme provides a structured way to define real-time programs (schedules) consisting of multiple parallel tracks with sequential steps. Originally designed for time-critical [rat experiments](https://www.sciencedirect.com/science/article/abs/pii/S0006899398009263), it now accommodates various scheduling scenarios:
+
+- 🍳 **Food Production**: Restaurant kitchens, bakery operations, meal coordination
+- 🔬 **Laboratory Research**: Experimental protocols, sample processing workflows  
+- ✈️ **Operations Management**: Airport scheduling, event planning, logistics
+- 🏭 **Manufacturing**: Assembly lines, quality control, batch processing
+- 🎬 **Media Production**: Film scheduling, broadcast coordination
+
+---
+
+## 🎯 Key Features
+
+- **Multi-track Execution**: Run multiple parallel tracks of operations
+- **Resource Constraints**: Enforce equipment/station availability limits
+- **Actor Constraints**: Track and limit human attention/involvement  
+- **Rich Start Triggers**: Time-based, dependency-based, or manual triggers
+- **Buffer Support**: Pre/post-step buffers with runtime extension capability
+- **Variable Durations**: Fixed, variable, or indefinite step durations
+- **Interactive Control**: Manual triggers and real-time adjustments
+- **Environment Catalog**: Reusable environment and resource definitions
+- **Real-time Monitoring**: Track progress with adjustable time scaling
+- **Schema Validation**: Comprehensive program validation
+
+For detailed information, see the [**Features Guide**](docs/FEATURES.md).
+
+---
+
+## 📖 Example Program
+
+Here's a simple breakfast preparation program:
+
+```json
+{
+  "programId": "breakfast-prep",
+  "name": "Breakfast Preparation",
+  "environment": "home-kitchen",
+  "startTrigger": {"type": "manual"},
+  "tracks": [
+    {
+      "trackId": "eggs",
+      "name": "Scrambled Eggs",
+      "steps": [
+        {
+          "stepId": "fry-eggs",
+          "name": "Fry Eggs",
+          "startTrigger": {"type": "programStart"},
+          "task": "stove-burner",
+          "duration": {"type": "fixed", "seconds": 180}
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Environment with Resource Constraints
+
+```json
+{
+  "environmentId": "home-kitchen",
+  "actors": 2,
+  "resourceConstraints": [
+    {
+      "task": "stove-burner",
+      "maxConcurrent": 4,
+      "actorsRequired": 1.0
+    },
+    {
+      "task": "oven", 
+      "maxConcurrent": 1,
+      "actorsRequired": 0.5
+    }
+  ]
+}
+```
+
+---
+
+## 🛠️ Installation
+
+> **Note**: Rhylthyme packages are currently in development and must be installed from local directories.
+
+### Quick Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/rhylthyme.git
+cd rhylthyme
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # Windows: venv\Scripts\activate
+
+# Install core packages
+pip install -e ./rhylthyme-spec
+pip install -e ./rhylthyme-cli-runner
+pip install -e ./rhylthyme-web
+
+# Verify installation
+rhylthyme --help
+```
+
+For detailed installation instructions, see the [**Installation Guide**](docs/INSTALLATION_GUIDE.md).
+
+---
+
+## 🏃‍♂️ Usage
+
+### CLI Runner
+
+```bash
+# Validate a program
+rhylthyme validate programs/example.json
+
+# Run a program with interactive terminal UI
+rhylthyme run programs/example.json
+
+# Run with automatic start and 2x speed
+rhylthyme run programs/example.json --auto-start --time-scale 2.0
+
+# Optimize a program schedule
+rhylthyme plan programs/example.json optimized.json
+
+# List available environments
+rhylthyme environments
+
+# Get help
+rhylthyme --help
+```
+
+#### Interactive Controls
+
+When running a program, use these keyboard controls:
+
+- **Space**: Start/stop program
+- **Enter**: Trigger manual steps
+- **Arrow keys**: Navigate between steps
+- **q**: Quit
+- **r**: Refresh display
+
+### Web Visualizer
+
+Start the web server:
+
+```bash
+rhylthyme-web
+```
+
+Then open http://localhost:5000 in your browser. You can:
+- **Upload** a local .json or .yaml file
+- **Paste a URL** to load from https
+- **Try examples** with one click
+
+Options:
+```bash
+rhylthyme-web --port 8080 --debug
+```
+
+#### Command Line Visualization
+
+```bash
+# Generate and open visualization in browser
+rhylthyme-visualize program.json
+
+# Save to specific file without opening browser
+rhylthyme-visualize program.json -o output.html --no-browser
+```
+
+### Importers
+
+Import schedules from external sources:
+
+```bash
+# Install importers
+pip install -e ./rhylthyme-importers
+
+# Search TheMealDB for recipes
+rhylthyme-import search "chicken curry" -i themealdb
+
+# Import a recipe
+rhylthyme-import import "52772" -o curry.json --pretty
+
+# Import a random meal
+rhylthyme-import mealdb random -o random_meal.json
+
+# Import from protocols.io (requires API token)
+export PROTOCOLS_IO_TOKEN="your_token"
+rhylthyme-import search "western blot" -i protocolsio
+```
+
+The web chat also supports importing - just ask Claude to "import a recipe for lasagna" or "find me a chicken recipe".
+
+---
+
+## 📁 Project Structure
+
+```
+rhylthyme/
+├── rhylthyme-spec/                # Schema definitions
+├── rhylthyme-cli-runner/         # Command-line interface
+├── rhylthyme-web/                # Web visualizer & DAG generator
+├── rhylthyme-importers/          # Import plugins (TheMealDB, protocols.io)
+├── rhylthyme-examples/           # Example programs & environments
+├── rhylthyme-docs/               # Documentation website
+├── rhylthyme-mcp-server/         # MCP server implementation
+├── docs/                         # Core documentation
+├── extensions/                   # Extensions and integrations
+└── DOCUMENTATION_INDEX.md        # Complete documentation index
+```
+
+---
+
+## 📚 Documentation
+
+### Quick Links
+- 📋 [**Documentation Index**](DOCUMENTATION_INDEX.md) - Complete guide to all documentation
+- 🎓 [**Getting Started Tutorial**](docs/GETTING_STARTED.md) - Complete beginner's guide with examples
+- 🚀 [**Quick Start**](docs/QUICK_START.md) - Get started in minutes  
+- 📖 [**Schema Guide**](docs/SCHEMA_GUIDE.md) - Complete schema documentation
+- ⚡ [**Features**](docs/FEATURES.md) - Detailed feature descriptions
+- 🔧 [**Installation**](docs/INSTALLATION_GUIDE.md) - Detailed setup instructions
+
+### Tool Documentation
+- 🎮 [**Program Runner**](docs/RUNNER_README.md) - Interactive execution
+- ✅ [**Validator**](docs/VALIDATOR_README.md) - Program validation
+- 🌍 [**Environment Catalog**](docs/ENVIRONMENT_CATALOG.md) - Resource management
+- 🌐 [**Web Visualizer**](rhylthyme-web/README.md) - DAG visualization
+- 📥 [**Importers**](rhylthyme-importers/README.md) - TheMealDB & protocols.io import
+
+### Integration Guides
+- 📓 [**Marimo Integration**](docs/MARIMO_README.md) - Notebook interface
+- 🔌 [**MCP Server**](rhylthyme-mcp-server/README.md) - Model Context Protocol
+
+---
+
+## 📋 Examples
+
+Explore working examples in the [**rhylthyme-examples**](rhylthyme-examples/) directory:
+
+- `breakfast_schedule.json` - Simple breakfast coordination
+- `lab_experiment.json` - Laboratory protocol workflow  
+- `bakery_program_example.json` - Complex bakery production
+- `airport_program_example.json` - Airport operations scheduling
+- `rat_psychopharmacology.json` - Research experiment timing
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! See individual repository README files for specific contribution guidelines.
+
+### Getting Started
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests and documentation
+5. Submit a pull request
+
+---
+
+## 📄 License
+
+Apache License 2.0 - see [LICENSE](LICENSE) file for details.
+
+---
+
+## 🆘 Support
+
+- **🐛 Issues**: [GitHub Issues](../../issues)
+- **💬 Discussions**: [GitHub Discussions](../../discussions)  
+- **📖 Documentation**: [Documentation Index](DOCUMENTATION_INDEX.md)
+- **📧 Contact**: See individual repository contacts
+
+---
+
+*Rhylthyme: Making time-critical workflows as smooth as a perfect rhythm.* 🎵