@sdeverywhere/compile 0.7.5 → 0.7.6

package/README.md

@@ -1,11 +1,38 @@
 # @sdeverywhere/compile
 
-This package contains the core SDEverywhere compiler that takes a Vensim model
-as input and generates C code as output.
+This package contains the core [SDEverywhere](https://github.com/climateinteractive/SDEverywhere) compiler that takes a Vensim model as input and generates C code as output.
+
+## Quick Start
+
+The best way to get started with SDEverywhere is to follow the [Quick Start](https://github.com/climateinteractive/SDEverywhere#quick-start) instructions.
+If you follow those instructions, the `@sdeverywhere/cli` package will be added to your project automatically, and that package uses `@sdeverywhere/compile` as an implementation detail.
+Therefore, most users do not need to install this package directly.
+
+## Install
+
+As noted above, most users do not need to install this package directly, but for more advanced use cases, it can be installed as follows.
+
+```sh
+# npm
+npm install --save-dev @sdeverywhere/compile
+
+# pnpm
+pnpm add -D @sdeverywhere/compile
+
+# yarn
+yarn add -D @sdeverywhere/compile
+```
+
+## Usage
+
+Most users do not need to interact with the `@sdeverywhere/compile` package directly; it is primarily used in the implementation of the `@sdeverywhere/cli` package and `sde` command line tool.
+
+More usage details will be included here at a later time when the interfaces stabilize.
 
 ## Documentation
 
-TODO
+The `compile` package is currently treated as an implementation detail of the `cli` package.
+As such, there is no public API documentation at this time, but we hope to expose a public API once the interfaces stabilize.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdeverywhere/compile",
-  "version": "0.7.5",
+  "version": "0.7.6",
   "description": "The core Vensim to C compiler for the SDEverywhere tool suite.",
   "type": "module",
   "files": [

package/src/_shared/helpers.js

@@ -1,7 +1,7 @@
 import util from 'util'
 import B from 'bufx'
 import { parse as parseCsv } from 'csv-parse/sync'
-import R from 'ramda'
+import * as R from 'ramda'
 import split from 'split-string'
 import XLSX from 'xlsx'
 

package/src/_shared/read-dat.js

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import B from 'bufx'
 import byline from 'byline'
-import R from 'ramda'
+import * as R from 'ramda'
 
 import { canonicalVensimName } from './helpers.js'
 

package/src/_shared/subscript.js

@@ -1,7 +1,7 @@
 import util from 'util'
 import B from 'bufx'
 import yaml from 'js-yaml'
-import R from 'ramda'
+import * as R from 'ramda'
 import { canonicalName, asort, vlog } from './helpers.js'
 
 // A subscript is a dimension or an index.

package/src/generate/code-gen.js

@@ -1,4 +1,4 @@
-import R from 'ramda'
+import * as R from 'ramda'
 
 import { asort, lines, strlist, abend, mapIndexed } from '../_shared/helpers.js'
 import { sub, allDimensions, allMappings, subscriptFamilies } from '../_shared/subscript.js'

package/src/generate/equation-gen.js

@@ -1,6 +1,6 @@
 import path from 'path'
 import { ModelLexer, ModelParser } from 'antlr4-vensim'
-import R from 'ramda'
+import * as R from 'ramda'
 import XLSX from 'xlsx'
 
 import {

package/src/generate/model-lhs-reader.js

@@ -1,4 +1,4 @@
-import R from 'ramda'
+import * as R from 'ramda'
 
 import { canonicalName } from '../_shared/helpers.js'
 import { sub, isDimension } from '../_shared/subscript.js'

package/src/model/equation-reader.js

@@ -1,5 +1,5 @@
 import { ModelParser } from 'antlr4-vensim'
-import R from 'ramda'
+import * as R from 'ramda'
 
 import {
   canonicalName,

package/src/model/model.js

@@ -1,6 +1,6 @@
 import B from 'bufx'
 import yaml from 'js-yaml'
-import R from 'ramda'
+import * as R from 'ramda'
 
 import { decanonicalize, isIterable, listConcat, strlist, vlog, vsort } from '../_shared/helpers.js'
 import {

package/src/model/subscript-range-reader.js

@@ -1,6 +1,6 @@
 import path from 'path'
 import { ModelParser } from 'antlr4-vensim'
-import R from 'ramda'
+import * as R from 'ramda'
 import XLSX from 'xlsx'
 
 import { cFunctionName, matchRegex, readCsv } from '../_shared/helpers.js'

package/src/model/var-name-reader.js

@@ -1,4 +1,4 @@
-import R from 'ramda'
+import * as R from 'ramda'
 
 import { canonicalName } from '../_shared/helpers.js'
 import { sub, isIndex, normalizeSubscripts } from '../_shared/subscript.js'

package/src/model/variable-reader.js

@@ -1,5 +1,5 @@
 import { ModelParser } from 'antlr4-vensim'
-import R from 'ramda'
+import * as R from 'ramda'
 
 import { canonicalName, vlog, strlist, cartesianProductOf } from '../_shared/helpers.js'
 import {

package/src/preprocess/preprocessor.js

@@ -1,6 +1,6 @@
 import path from 'path'
 import B from 'bufx'
-import R from 'ramda'
+import * as R from 'ramda'
 import { splitEquations, replaceDelimitedStrings } from '../_shared/helpers.js'
 
 export let preprocessModel = (mdlFilename, spec, profile = 'genc', writeFiles = false, outDecls = []) => {