River Logiceode docs

New model

Start a model from a description, a workbook or a model file you already have, and find your way around the five-step wizard.

Where: New Model

New Model opens a five-step wizard: Describe, Clarify, Build, Load data and Solve. You say what the business does and what to optimize, answer RIA's questions, sign off the design, load your numbers, and get a first solved answer, the baseline.

Start a new model

  1. Click New Model in the rail. Step 1 opens on Tell us a bit about your business. Click Next.
  2. Under How do you want to author?, pick Basic to describe your business in words, or Advanced to bring a model you already have. Click Next.
  3. On Name your model, type a name and click Next.

Naming creates the model. It's in your Model Library from then on, with a Draft chip until it's built. "This name will be used throughout EODE to refer to this model. Try to make it unique." Renaming it on this screen later renames it in the library too.

Other ways to open the same wizard:

FromClick
Command paletteCtrl/⌘+K, type build, author or import, then New model…
The model menu in the headerNew model…
Model LibraryNew model above the list
HomeAuthor a model, shown when nothing is in flight

Opening New Model also starts a new, empty General conversation in the RIA console if the one open belongs to a model or already has your messages in it.

Choose how to start

You havePickThen
A description of the businessBasicDescribe your business
An Excel workbook with your numbersBasic, and attach it under Upload or select relevant datasourcesStart from a workbook
A Python model spec, a set of CSV tables, or a model file (.corz)AdvancedBring a model you already have

A model is either authored from your words or brought in from a file, never both; you can switch before the build.

Find your way around the wizard

The step rail on the left lists the five steps. Under the step you're on, it lists that step's screens. A step's number turns into a check when it's done.

PartWhat it does
Step railDone rows are green, the current row is highlighted, rows still ahead are grey. Click a done step, or a screen listed under the current one, to go there; Enter or Space works too. Steps ahead can't be opened.
Previous / NextThe bar at the top of the content. A dim Next still answers a click: it says what's missing beside the button. Next often carries the step's own action instead, like Finish answering or Solve for your baseline.
HeaderSTEP 2 OF 5 · CLARIFY and a pill: IN PROGRESS, WORKING, DONE, or STOPPED when a build stopped or a workbook can't be built yet.
? beside a titleShows or hides a line of help about that screen or row.

Clicking a step opens its first screen; Previous across a step boundary opens the last screen of the step before. Each step opens on an intro the first time you reach it, under "In this step you are able to:":

StepIntro
1 DescribeTell us a bit about your business
2 ClarifyA few questions before I build, with the scrutiny choice
3 BuildHere is the shape I propose
4 Load dataNow the numbers; its bullets change with what the build ran on (Load your data)
5 SolveLet us solve it

On a model started from a workbook, steps 3 to 5 list workbook bullets instead, such as "Choose the first slice: one business unit of your own rows".

Wait while eode works

Anything that runs on the server — reading your words, building, binding, solving — shows a working screen: the job's name, a progress bar and an elapsed clock, with Previous, Next and the step rail locked. "You can leave this page; the work keeps running."

You seeWhile
Reading what you told meeode reads your description after Describe
Reading your data / Reading your data against the modeleode reads an attached workbook, or checks it against the design
Checking whether anything else needs clarifyingafter Finish answering
Building your model / Recalculating the workbook for your pickthe build
Accepting the design / Rebuilding with your notesafter you sign off or send the design back
Binding your data to the model / Mapping your workbook into the modelyour data goes into the model
Submitting the solvethe baseline solve starts

After 90 seconds the line reads "This is taking longer than it should. Anything that started is still running, and nothing you did has been lost." Stop waiting and go back returns you to the page you were on, notes and answers intact; it stops the waiting, not the work. The mapping wait has no way out; it moves on by itself when the mapping lands.

Come back to a model

Close the tab or go elsewhere at any point. The work carries on, and the model remembers where you were.

To reopenClick
From the libraryEdit model (pencil) on the model's row, or click any model that isn't ready yet: a Draft, one paused for you, one building or one that failed
From the modelEdit model (pencil) in the model's header
From HomeThe pencil on a model in the list, or a row under MODELS AWAITING YOU
Persona other than Operator or Executive

The pencils and Author a model are hidden for the Operator and Executive personas. New Model in the rail isn't.

Where it opens:

  • On the screen you left, in this browser.
  • Otherwise on the first step the model hasn't finished. Describe is filled back in from the model: your description, hard limits, goal and datasets.
  • On a job's progress page if one is running, then forward by itself when it lands. A build that stops after you've moved on brings you back to Build; a build that has more questions for you opens Clarify on them.
  • On Your model at Solve if the model is already solved.

Clarify answers and notes save to the model as you go, on any browser, with the question you were on: the line above the questions reads "Answers save as you go." If a save fails it reads "Your latest edits are saved in this browser only.", with Retry saving.

Your place, the Describe draft, the scrutiny choice and your notes on Load data are kept in this browser, per model. A model you started but didn't name yet comes back the next time you click New Model. Files picked under Advanced aren't kept.

Go back and change something

Previous and the rail never rebuild anything: go back and change nothing, and Next moves on without rebuilding. Changing a step that has work after it asks first. A build that's still running can't be reopened; wait for it to land or stop.

You changeYou're askedConfirm withRedone
Describe, then NextChange the description?Discard and read it againeverything after it is discarded: your Clarify answers and notes, the model design, the build, the data you loaded and the solves; the description is read again from the start
A Clarify answer, then Finish answeringChange your answers?Change my answersthe build and the baseline; the data you loaded carries over wherever it still fits
The data choice on a solved modelChange the data?Change the datathe baseline
What's used from a workbook you agreedChange what is used from your data?Go back to the readingsee Start from a workbook

Change your answers? and Change the data? add "Nothing you entered is lost." Keep the description as it was backs out of a description change and puts the description back as the model has it. The check compares with the description the model holds, so a change made on another browser asks too.

Stop or cancel

Only a solve can be stopped, with Stop on its progress screen (Build and baseline). A build, a reading of your data, a mapping and the check after Finish answering can't be cancelled.

Bring a model you already have

Advanced replaces the description screens with Use advanced imports: "Pick one. The model you bring is the model: nothing is authored on top of it." Open a row with Add, fill its screens, then Finish to come back to this list. Next here runs the import.

RowNext readsBrings in
Python model specsBuild from my specA spec.json your own script writes, or a .zip with it
CSV data packsScaffold on my dataYour tables of sites, products and customers, with a one-line brief
The third row, for a model fileImport my modelA .corz model file

Opening a second row asks Switch imports? — "One import per model. Switching drops" the first "and opens" the second — with Switch and Cancel. The files you pick live only on the page; after a reload, Next asks "Pick the file again: a reload keeps its name, not the file."

Python model specs

  1. Get the starter: Starter script downloads the script; JSON schemas opens the schemas in a new tab. Your script writes a spec.json.
  2. Upload your spec: "The spec.json your script emitted, or the .zip with data/*.csv inside it." Click Upload spec (.json / .zip).
  3. Finish, then Build from my spec.

Review structure before building is ticked by default. It holds a spec with nodes and edges for you to review before it builds. Any other spec builds and solves straight away, ticked or not. A .zip only works for a spec with nodes and edges; other specs carry their data inside the JSON.

CSV data packs

  1. Your brief and objective: one line in Model brief ("One line: what should this model decide? (e.g. weekly production mix across our plants)"), at least ten characters, and Maximize profit or Minimize cost.
  2. On the second screen, pick your tables: .csv or .xlsx, one per table. A .md file is read as a data dictionary. Starter workbook (.xlsx) and Starter tables (.csv zip) give you the layout.
  3. Finish, then Scaffold on my data.

The tables are read by name: products with a product column for what you sell, works with a works column for sites, and customers with a customer_account column for accounts. Capitals, spaces and punctuation don't matter; the words do. The tables become one dataset, and the model goes on as if you had attached a workbook (Start from a workbook).

A model file

The third row takes a .corz file you already have; attach spreadsheets under Basic instead. Click Import .corz, then Finish and Import my model. Tick Run a base solve after import (off by default) to solve it and create the Base scenario in the same step. The model is imported as it is, with no questions and no data step, and solves on its own numbers. A stopped import offers Upload the file again on Build, which starts a new model under the same name; the stopped one stays in the library.

If an import is refused

Refused withFix
"file must be a .json spec or a .zip bundle"Upload a .json or .zip
"not a readable .zip bundle" / "bundle has no spec.json at its root"Zip again with spec.json at the top
"spec failed validation" and a countCorrect each field the error names against the schemas
"only .csv tables, .xlsx workbooks and .md dictionaries are accepted"Drop the other file
"your tables could not be read as a dataset, so no model was started"Check each table has its column names in the first row, then upload again
A model file's reason, in the RIA consoleFix what it names and upload again

Ask RIA instead

With New Model open, the RIA console takes a description too: "Describe your business: products, prices, capacities, demand." Its chips are Plan a 10-product bakery, Describe my own decision and Import a workbook.

Limits

  • A wait shows Stop waiting and go back after 90 seconds.
  • A model file can be up to 512 MB. Other uploads go through a 100 MB limit.
  • A CSV data pack's brief needs at least 10 characters.
  • One import per model, and one dataset per model.
  • Your place in the wizard is kept per browser, not per account.

On this page