synai-simulator 0.1.4 → 0.1.5

package/LICENSE

@@ -0,0 +1,194 @@
+                                 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
+
+NOTICE
+
+Copyright 2026 Omar Bradai
+
+This product includes software developed by Omar Bradai.
+
+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.

package/README.md

@@ -1,4 +1,5 @@
 # synai-simulator
+
 > Experimental prototype — open to discussion and collaboration.
 
 ## Purpose
@@ -7,9 +8,9 @@
 
 It is designed to help researchers, engineers, and system architects understand how different scheduling strategies, resource bottlenecks, and failure modes affect:
 
-* system stability
-* throughput
-* fairness
+- system stability
+- throughput
+- fairness
 
 The simulator provides a controlled environment to experiment with real-world system dynamics rather than idealized steady-state behavior.
 
@@ -17,22 +18,22 @@ The simulator provides a controlled environment to experiment with real-world sy
 
 ## What It Simulates
 
-* **Task Lifecycle**
+- **Task Lifecycle**
   Tasks are created, queued, scheduled, executed, and eventually completed or failed.
 
-* **Resource Management**
+- **Resource Management**
   Simulates CPU and RAM allocation, contention, and pressure.
 
-* **Worker Model**
+- **Worker Model**
   Workers have fixed resource limits and can execute multiple tasks concurrently.
 
-* **Scheduling Policies**
+- **Scheduling Policies**
   Multiple policies determine which tasks are admitted and prioritized.
 
-* **Failure Modes**
+- **Failure Modes**
   Realistic failure scenarios caused by pressure, timeouts, starvation, or load shedding.
 
-* **System Metrics**
+- **System Metrics**
   Continuous measurement of pressure, queue length, failures, throughput, and stability.
 
 ---
@@ -42,27 +43,27 @@ The simulator provides a controlled environment to experiment with real-world sy
 1. **Initialization**
    The system is initialized with:
 
-   * total CPU and RAM
-   * a set of workers
-   * a scheduling policy
+   - total CPU and RAM
+   - a set of workers
+   - a scheduling policy
 
 2. **Task Admission**
    Tasks enter the system with:
 
-   * resource usage profiles
-   * deadlines
-   * failure probabilities
+   - resource usage profiles
+   - deadlines
+   - failure probabilities
 
 3. **Tick Loop**
    The simulation advances in discrete time steps (“ticks”).
 
    Each tick performs:
 
-   * Metrics computation
-   * Scheduling decisions
-   * Task execution progress
-   * Failure evaluation
-   * Metrics update
+   - Metrics computation
+   - Scheduling decisions
+   - Task execution progress
+   - Failure evaluation
+   - Metrics update
 
 4. **Visualization (Demo)**
    A browser-based demo renders pressure, task states, and metrics in real time.
@@ -71,16 +72,16 @@ The simulator provides a controlled environment to experiment with real-world sy
 
 ## Why Use synai-simulator?
 
-* **Research**
+- **Research**
   Explore the behavior of scheduling strategies under stress.
 
-* **System Design**
+- **System Design**
   Prototype and validate new schedulers or resource models.
 
-* **Education**
+- **Education**
   Demonstrate distributed system concepts and failure cascades.
 
-* **Analysis**
+- **Analysis**
   Quantify stability, fairness, and throughput trade-offs.
 
 ---
@@ -89,64 +90,64 @@ The simulator provides a controlled environment to experiment with real-world sy
 
 ### Core Concepts
 
-* **SystemState**
+- **SystemState**
   Full snapshot of the system:
 
-  * time
-  * resources
-  * workers
-  * tasks
-  * metrics
-  * active policy
+  - time
+  - resources
+  - workers
+  - tasks
+  - metrics
+  - active policy
 
-* **Task**
+- **Task**
   A unit of work with:
 
-  * resource usage curves
-  * deadline
-  * progress
-  * failure risk
+  - resource usage curves
+  - deadline
+  - progress
+  - failure risk
 
-* **Worker**
+- **Worker**
   A resource-constrained execution unit.
 
-* **Policy**
+- **Policy**
   A set of weights guiding scheduling decisions.
 
 ---
 
 ### Scheduling Policies
 
-* **FAIRNESS**
+- **FAIRNESS**
 
-  * Prioritizes older tasks
-  * Penalizes starvation
+  - Prioritizes older tasks
+  - Penalizes starvation
 
-* **BALANCED**
+- **BALANCED**
 
-  * Mixes task age and execution cost
+  - Mixes task age and execution cost
 
-* **THROUGHPUT**
+- **THROUGHPUT**
 
-  * Favors cheaper tasks to maximize completions
+  - Favors cheaper tasks to maximize completions
 
 ---
 
 ### Failure Modes
 
-* **Starvation**
+- **Starvation**
   A queued task fails if it waits too long under high pressure.
 
-* **Timeout**
+- **Timeout**
   A task fails if it exceeds its deadline while the system is under pressure.
 
-* **Load Shedding**
+- **Load Shedding**
   When pressure exceeds a threshold, the most expensive queued task is dropped.
 
-* **Pressure-Induced Failure**
+- **Pressure-Induced Failure**
   Running tasks may fail probabilistically based on pressure and task risk.
 
-* **Random Failure**
+- **Random Failure**
   Simulates unpredictable external failures.
 
 ---
@@ -310,9 +311,9 @@ A browser-based demo is included.
 
 You can:
 
-* add tasks
-* change policies
-* observe pressure, failures, and stability in real time
+- add tasks
+- change policies
+- observe pressure, failures, and stability in real time
 
 ---
 
@@ -337,4 +338,4 @@ Please open an issue or submit a pull request.
 
 ## License
 
-MIT License
+Apache License Version 2.0, January 2004

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "synai-simulator",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,5 +14,6 @@
   "devDependencies": {
     "tsup": "^8.0.0",
     "typescript": "^5.0.0"
-  }
+  },
+  "license": "Apache-2.0"
 }