Public help • always user-focused

How PyMox works, end to end.

This page documents every major element of the app and how they connect: systems, buses, loads, storage, converters, strategies, simulations, and the dashboards that surface results. It is public and read-only.

At a glance
  • Your system definition becomes a connected energy map.
  • Simulations evaluate loads, solar, grid, and battery state over time.
  • Strategies decide when to charge, discharge, or use the grid.
  • Dashboards summarize performance, history, and forecast scenarios.
Private features like dashboard access, system editing, and billing require authentication.

Core concepts

PyMox models a real power system. These concepts map directly to what you configure in the app.

System

The top-level container for topology, location, thermal parameters, and strategy.

  • Location: latitude and longitude for solar and weather.
  • Thermal mass and heat loss drive climate-aware loads.
  • Strategy determines dispatch priorities.
Power buses

DC or AC buses define voltage domains and capacity constraints.

  • Loads, batteries, chargers, and grid connections attach to buses.
  • Converters bridge buses with efficiency and standby cost.
Loads and profiles

Loads can be static or scheduled to reflect real behavior.

  • Schedules describe HVAC, occupancy, daylight, and heating patterns.
  • Schedules map to device-level consumption curves during simulation.
Storage

Batteries define capacity, SoC limits, and charge/discharge power.

  • Daily rollups seed simulations and show real SoC history.
  • Manual rollups can correct or backfill data.
Generation

Chargers represent power sources and connect to buses.

  • Solar, wind, alternator, and generator chargers are supported.
  • Each charger contributes generation to its bus by type.
Grid connection

Grid links define import/export power limits and event history.

  • Grid events record connect/disconnect timelines.
  • Forecasting can plan scheduled grid availability.
Load

Loads represent everything that consumes power on a bus.

  • Name and icon help you identify the device or category.
  • Rated power sets the baseline draw used by the simulator.
  • Power bus determines which voltage domain supplies the load.
  • Power profile adds schedules and behavior curves for realistic demand.
  • Enabled flag allows you to include or exclude the load in runs.
Battery

Batteries store energy and buffer peaks.

  • Capacity (Wh) sets total available energy.
  • Min and max SoC define usable energy limits and safety buffers.
  • Max charge/discharge power caps how fast energy can move.
  • Round-trip efficiency applies conversion loss during charge and discharge.
  • Enabled flag includes or excludes the battery from dispatch.
  • Daily rollups set the starting SoC baseline for simulations.
Charger

Chargers represent energy sources feeding a bus.

  • Type determines generation behavior (solar, wind, alternator, generator).
  • Max charge power sets a ceiling for produced energy.
  • Efficiency applies conversion loss before power reaches the bus.
  • Power bus defines where generated energy enters the system.
  • Enabled flag controls whether the source participates in simulations.
Grid

Grid connections define how the system interacts with shore power.

  • Max import power caps how much energy can be pulled from the grid.
  • Max export power caps how much energy can be pushed back.
  • Grid events record connection state changes used in simulations.
  • Forecasting can model scheduled grid availability.
  • Power bus defines the grid entry point.
Converter

Converters move energy between buses with limits and losses.

  • Input and output buses define the direction of conversion.
  • Max power caps how much energy can pass through each step.
  • Efficiency reduces delivered power based on losses.
  • Standby power adds constant overhead when enabled.
  • Enabled flag decides whether the converter is active.

Workflow: from system to insight

PyMox converts your system setup into a connected energy map, runs simulations with real constraints, then renders dashboards for planning and monitoring.

1. Define system

Onboarding or the System page creates buses, loads, storage, and sources.

2. Build the energy map

Your components form a connected map that mirrors the real system.

3. Simulate

Simulations evaluate each time step, dispatch, and energy routing.

4. Surface insights

Dashboards present SoC, runtime, grid impact, and forecasted risk.

How data moves
  • System configuration is captured through system, bus, load, battery, charger, and converter settings.
  • The app builds a connected map so the simulator understands how energy can move.
  • Simulations combine rollups, grid events, and weather to build a time-based run.
  • Results feed dashboards for daily, performance, forecast, and historical views.
Real-time data flows are anchored by rollups. If no rollups are present, the app falls back to defaults for initial SoC and climate.

UI guide

Where to go in the product and what each screen does.

Onboarding wizard

Step-by-step setup for categories, strategy, sources, batteries, and loads.

  • Captures location and thermal assumptions for climate-aware forecasting.
  • Builds suggested buses and converter connections.
  • Generates the first system for your team.
System

The system map and resource panels live here.

  • Resource panels manage buses, loads, batteries, chargers, grid connections, and converters.
  • System flow diagram shows the relationships between components.
Dashboard

A daily snapshot with SoC, runtime, and net power signals.

  • Uses simulation results for the current day.
  • Highlights net surplus or deficit with status labels.
Performance

Last 24 hours of grid, battery, and self-consumption performance.

  • Combines grid import/export with battery rollups.
  • Calculates estimated cost and backup runtime.
Forecasting

Plan days ahead with adjustable reserve, usage, and grid schedules.

  • Supports manual battery rollups to refine the baseline.
  • Lets you scale panel, battery, and load assumptions.
Historical

Explore ranges from today to 90 days with energy breakdowns.

  • Tracks deep discharge events and deficit summaries.
  • Compares solar, load, conversion loss, and grid impact.
Simulations

Scenario dashboards for long-range planning.

  • Resolution supports hourly, daily, monthly, and yearly views.
  • Some views may show placeholders while scenario data is finalized.
Billing

Subscription management for teams with checkout and a billing portal.

  • Plan selection and portal access are team-aware.
Teams and API tokens

Team members, roles, and API tokens are managed in the account area.

  • Teams gate access to shared systems and billing.
  • API tokens use scoped permissions for integrations.

Simulation

PyMox simulates the system step-by-step using dispatch strategies, converter constraints, and dynamic loads.

Per-step process
  1. Evaluate load profiles and thermal demand for each bus.
  2. Estimate solar production and generator contribution.
  3. Build a snapshot with load, solar, battery, and grid states.
  4. Run the dispatch strategy to decide charge, discharge, and grid use.
  5. Route energy through converters to satisfy demand.
  6. Update battery SoC and grid import/export for the step.
Strategies
  • Self-consumption prioritizes local solar and storage.
  • Peak shaving reduces grid peaks using batteries.
  • Price optimization shifts usage based on grid costs.
  • Resilience (island) favors self-sufficiency.
Strategy is chosen per system and applied during simulation runs.
Topology and converters

Buses, loads, storage, and converters form a graph. The simulator decides how energy moves between buses and how converter efficiency affects net delivery.

Data inputs and rollups

Forecasts and history rely on rollups and external data sources. These feed the baseline for simulations and charts.

Battery rollups

Daily SoC rollups establish the starting point for simulations.

  • Sources include API and manual entries.
  • Used for both SoC percent and kWh series.
Climate rollups

Daily temperature rollups seed climate and HVAC demand modeling.

  • Stored per system with min, max, and last temperature.
Weather data

Forecasted outdoor temperatures inform climate-aware loads.

  • Forecasting supports auto or overridden assumptions.
  • SolarProductionEstimator uses location data.
Grid events

Grid connection changes are stored as events.

  • Events annotate simulations and chart overlays.
  • Forecasting can plan grid availability schedules.
System resources

System resources keep configuration consistent across the app.

  • Validates input types and converts percent fields.
  • Manages charger subtypes and resource panels.
Charts and visualization

Charts render series built from your simulation and rollup data.

  • Series and categories are built per view.
  • Visual settings adjust per context.

Troubleshooting

Common issues and what to check first.

No data in charts
  • Confirm a System exists and is set as active for your team.
  • Check that batteries, loads, and buses are configured and enabled.
  • Verify rollups exist or that default fallbacks are acceptable.
Forecasting looks off
  • Review location and weather assumptions.
  • Adjust reserve, panel, battery, and usage scaling factors.
  • Confirm grid schedule mode and grid events.
Unexpected deficits
  • Inspect converter efficiencies and standby power.
  • Check load profiles for high peak demand.
  • Validate battery power limits vs. total load.
Billing access issues
  • Ensure you are on a team with a configured plan.
  • Billing portal requires an active subscription.