olcabasic 0.1.0__tar.gz

olcabasic-0.1.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: olcabasic
+Version: 0.1.0
+Summary: A BASIC-like language for controlling openLCA
+Author-email: Below280 <info@below280.com>
+License: MPL-2.0
+Project-URL: Homepage, https://github.com/Below280/olcaBASIC
+Project-URL: Repository, https://github.com/Below280/olcaBASIC
+Project-URL: Issues, https://github.com/Below280/olcaBASIC/issues
+Keywords: lca,openlca,basic,dsl,life-cycle-assessment
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: b280-olca-mcp>=1.11
+
+# olcaBASIC
+
+```
+            ___  _     ____    _    ____    _    ____  _  ____
+           / _ \| |   / ___|  / \  | __ )  / \  / ___|| |/ ___|
+          | | | | |  | |     / _ \ |  _ \ / _ \ \___ \| | |
+          | |_| | |__| |___ / ___ \| |_) / ___ \ ___) | | |___
+           \___/|_____\____/_/   \_\____/_/   \_\____/|_|\____|
+```
+
+**A simplified language to control openLCA, borrowing heavily from
+the BASIC programming language (1964)**
+
+olcaBASIC lets LCA practitioners build models, run calculations, and
+analyse results without writing Python. It connects to openLCA via the
+IPC server and translates simple, readable commands into the full power
+of the openLCA calculation engine.
+
+## Quick start
+
+```
+pip install olcabasic
+```
+
+Start the IPC server in openLCA (Tools > Developer Tools > IPC Server),
+then:
+
+```
+olcabasic
+```
+
+```
+olcaBASIC v0.1.0
+Connected to openLCA on port 8080 (ecoinvent 3.10)
+Ready.
+
+> PRINT PROCESSES("electricity", "", "GB")
+  electricity production, wind, 1-3MW | GB
+  electricity production, natural gas | GB
+  ...
+
+> PRINT METHODS("ReCiPe")
+  ReCiPe 2016 Midpoint (H)
+  ReCiPe 2016 Endpoint (H)
+
+> CALCULATE "My System" USING "ReCiPe 2016 Midpoint (H)"
+  Climate change:    247.3 kg CO2-eq
+  Ozone depletion:   3.21e-6 kg CFC-11-eq
+  ...
+```
+
+## Write programs
+
+Save as `mymodel.baslca` and run with `olcabasic run mymodel.baslca`:
+
+```basic
+REM Concrete block EPD model
+
+LET cement_mass = 300
+LET water_cement_ratio = 0.45
+LET mixing_energy = 12
+
+FLOW "Concrete block", m3, PRODUCT
+
+BRIDGE "BRIDGE | Cement | kg", kg
+  FOLDER "00: Concrete/Bridges"
+  PROVIDER "cement production, Portland | GB"
+END BRIDGE
+
+PROCESS "A1: Raw materials" LOCATION "GB"
+  FOLDER "00: Concrete/A1"
+  OUTPUT "Concrete block", 1, m3, PRODUCT
+  INPUT "BRIDGE | Cement | kg", cement_mass, kg
+  INPUT "BRIDGE | Sand | kg", 800, kg
+  INPUT "BRIDGE | UK grid | kWh", mixing_energy, kWh
+END PROCESS
+
+SYSTEM "A1: Raw materials"
+CALCULATE "A1: Raw materials" USING "EN15804+A2 (EF 3.1)"
+PRINT RESULTS
+
+SENSITIVITY ON "A1: Raw materials" USING "EN15804+A2 (EF 3.1)" BY 20%
+  VARY cement_mass
+  VARY mixing_energy
+END SENSITIVITY
+
+SCENARIO "Baseline"
+END SCENARIO
+
+SCENARIO "Low cement"
+  LET cement_mass = 240
+END SCENARIO
+
+RUN SCENARIOS ON "A1: Raw materials" USING "EN15804+A2 (EF 3.1)"
+SAVE RESULTS "scenarios.csv"
+```
+
+## Why?
+
+Brightway is powerful but requires Python fluency. SimaPro is
+point-and-click but not scriptable. olcaBASIC sits in between:
+programmatic, reproducible LCA work that any environmental scientist
+can read and write on day one.
+
+## Requirements
+
+- openLCA 2.x with IPC server running (port 8080)
+- Python 3.10+
+- `b280-olca-mcp` (installed automatically)
+
+## Licence
+
+MPL-2.0
+
+## Links
+
+- [Language specification](./olcaBASIC_Language_Specification_v1.md)
+- [B280 openLCA MCP](https://github.com/Below280/B280-olca-MCP)
+- [B280 Python IPC tools](https://github.com/Below280/openLCA-IPC-tools-python)
+- [Below280](https://below280.com)
+
+*Built by Below280. openLCA is developed by GreenDelta.*
+*BASIC was created by Kemeny and Kurtz at Dartmouth College, 1964.*

olcabasic-0.1.0/README.md

@@ -0,0 +1,123 @@
+# olcaBASIC
+
+```
+            ___  _     ____    _    ____    _    ____  _  ____
+           / _ \| |   / ___|  / \  | __ )  / \  / ___|| |/ ___|
+          | | | | |  | |     / _ \ |  _ \ / _ \ \___ \| | |
+          | |_| | |__| |___ / ___ \| |_) / ___ \ ___) | | |___
+           \___/|_____\____/_/   \_\____/_/   \_\____/|_|\____|
+```
+
+**A simplified language to control openLCA, borrowing heavily from
+the BASIC programming language (1964)**
+
+olcaBASIC lets LCA practitioners build models, run calculations, and
+analyse results without writing Python. It connects to openLCA via the
+IPC server and translates simple, readable commands into the full power
+of the openLCA calculation engine.
+
+## Quick start
+
+```
+pip install olcabasic
+```
+
+Start the IPC server in openLCA (Tools > Developer Tools > IPC Server),
+then:
+
+```
+olcabasic
+```
+
+```
+olcaBASIC v0.1.0
+Connected to openLCA on port 8080 (ecoinvent 3.10)
+Ready.
+
+> PRINT PROCESSES("electricity", "", "GB")
+  electricity production, wind, 1-3MW | GB
+  electricity production, natural gas | GB
+  ...
+
+> PRINT METHODS("ReCiPe")
+  ReCiPe 2016 Midpoint (H)
+  ReCiPe 2016 Endpoint (H)
+
+> CALCULATE "My System" USING "ReCiPe 2016 Midpoint (H)"
+  Climate change:    247.3 kg CO2-eq
+  Ozone depletion:   3.21e-6 kg CFC-11-eq
+  ...
+```
+
+## Write programs
+
+Save as `mymodel.baslca` and run with `olcabasic run mymodel.baslca`:
+
+```basic
+REM Concrete block EPD model
+
+LET cement_mass = 300
+LET water_cement_ratio = 0.45
+LET mixing_energy = 12
+
+FLOW "Concrete block", m3, PRODUCT
+
+BRIDGE "BRIDGE | Cement | kg", kg
+  FOLDER "00: Concrete/Bridges"
+  PROVIDER "cement production, Portland | GB"
+END BRIDGE
+
+PROCESS "A1: Raw materials" LOCATION "GB"
+  FOLDER "00: Concrete/A1"
+  OUTPUT "Concrete block", 1, m3, PRODUCT
+  INPUT "BRIDGE | Cement | kg", cement_mass, kg
+  INPUT "BRIDGE | Sand | kg", 800, kg
+  INPUT "BRIDGE | UK grid | kWh", mixing_energy, kWh
+END PROCESS
+
+SYSTEM "A1: Raw materials"
+CALCULATE "A1: Raw materials" USING "EN15804+A2 (EF 3.1)"
+PRINT RESULTS
+
+SENSITIVITY ON "A1: Raw materials" USING "EN15804+A2 (EF 3.1)" BY 20%
+  VARY cement_mass
+  VARY mixing_energy
+END SENSITIVITY
+
+SCENARIO "Baseline"
+END SCENARIO
+
+SCENARIO "Low cement"
+  LET cement_mass = 240
+END SCENARIO
+
+RUN SCENARIOS ON "A1: Raw materials" USING "EN15804+A2 (EF 3.1)"
+SAVE RESULTS "scenarios.csv"
+```
+
+## Why?
+
+Brightway is powerful but requires Python fluency. SimaPro is
+point-and-click but not scriptable. olcaBASIC sits in between:
+programmatic, reproducible LCA work that any environmental scientist
+can read and write on day one.
+
+## Requirements
+
+- openLCA 2.x with IPC server running (port 8080)
+- Python 3.10+
+- `b280-olca-mcp` (installed automatically)
+
+## Licence
+
+MPL-2.0
+
+## Links
+
+- [Language specification](./olcaBASIC_Language_Specification_v1.md)
+- [B280 openLCA MCP](https://github.com/Below280/B280-olca-MCP)
+- [B280 Python IPC tools](https://github.com/Below280/openLCA-IPC-tools-python)
+- [Below280](https://below280.com)
+
+*Built by Below280. openLCA is developed by GreenDelta.*
+*BASIC was created by Kemeny and Kurtz at Dartmouth College, 1964.*

olcabasic-0.1.0/olcabasic/__init__.py

@@ -0,0 +1,3 @@
+"""olcaBASIC — a BASIC-like language for openLCA."""
+
+__version__ = "0.1.0"

olcabasic-0.1.0/olcabasic/__main__.py

@@ -0,0 +1,109 @@
+"""
+olcaBASIC — entry point.
+
+Usage:
+    python -m olcabasic              Interactive REPL
+    python -m olcabasic run file.baslca  Run a program
+    python -m olcabasic --port 8090   Connect on a different port
+"""
+
+import argparse
+import sys
+
+BANNER = r"""
+            ___  _     ____    _    ____    _    ____  _  ____
+           / _ \| |   / ___|  / \  | __ )  / \  / ___|| |/ ___|
+          | | | | |  | |     / _ \ |  _ \ / _ \ \___ \| | |
+          | |_| | |__| |___ / ___ \| |_) / ___ \ ___) | | |___
+           \___/|_____\____/_/   \_\____/_/   \_\____/|_|\____|
+
+     A simplified language to control openLCA, borrowing heavily
+              from the BASIC programming language (1964)
+
+                         by Below280
+"""
+
+VERSION = "0.1.0"
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="olcaBASIC — BASIC-like language for openLCA",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "command", nargs="?", default=None,
+        help="'run' to execute a .baslca file",
+    )
+    parser.add_argument(
+        "file", nargs="?", default=None,
+        help="Path to .baslca file (used with 'run')",
+    )
+    parser.add_argument(
+        "--port", type=int, default=8080,
+        help="openLCA IPC port (default: 8080)",
+    )
+    parser.add_argument(
+        "--no-connect", action="store_true",
+        help="Start without connecting to openLCA (offline mode)",
+    )
+    parser.add_argument(
+        "--version", action="version",
+        version=f"olcaBASIC {VERSION}",
+    )
+
+    args = parser.parse_args()
+
+    print(BANNER)
+    print(f"  olcaBASIC v{VERSION}")
+
+    # Import here so startup errors are caught cleanly
+    from .repl import REPL
+    from .interpreter import Interpreter
+    from .bridge import LCABridge
+
+    # Connect to openLCA
+    bridge = None
+    if not args.no_connect:
+        bridge = LCABridge(port=args.port)
+        if bridge.connect():
+            info = bridge.database_info()
+            family = info.get("database_family", "unknown")
+            procs = info.get("processes", "?")
+            methods = info.get("impact_methods", "?")
+            print(f"  Connected to openLCA on port {args.port}")
+            print(f"  Database: {procs} processes, {methods} methods")
+            print(f"  Family:   {family} (auto-detected)")
+        else:
+            print(f"\n  WARNING: Cannot connect to openLCA on port {args.port}")
+            print("  Start the IPC server in openLCA:")
+            print("    Tools > Developer Tools > IPC Server > play button")
+            print("  Running in offline mode (search/build/calculate disabled)\n")
+            bridge = None
+    else:
+        print("  Offline mode (no openLCA connection)")
+
+    print("  Ready.\n")
+
+    interpreter = Interpreter(bridge)
+
+    if args.command == "run" and args.file:
+        # Program mode: run a .baslca file
+        try:
+            with open(args.file, "r") as f:
+                source = f.read()
+            interpreter.run_program(source, filename=args.file)
+        except FileNotFoundError:
+            print(f"File not found: {args.file}")
+            sys.exit(1)
+        except Exception as e:
+            print(f"Error: {e}")
+            sys.exit(1)
+    else:
+        # Interactive REPL
+        repl = REPL(interpreter)
+        repl.run()
+
+
+if __name__ == "__main__":
+    main()