diff --git a/.gitignore b/.gitignore index 44a76a7..990f8eb 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ /zero_engine opencode.Containerfile compose.yaml + +.venv diff --git a/docs/assumptions.md b/docs/assumptions.md new file mode 100644 index 0000000..b8c572f --- /dev/null +++ b/docs/assumptions.md @@ -0,0 +1 @@ +# Model Assumptions diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md new file mode 100644 index 0000000..42e34a2 --- /dev/null +++ b/docs/dev/architecture.md @@ -0,0 +1 @@ +# Architecture Overview diff --git a/docs/engine/consistency_checks.md b/docs/dev/engine/consistency_checks.md similarity index 100% rename from docs/engine/consistency_checks.md rename to docs/dev/engine/consistency_checks.md diff --git a/docs/engine/data_structures/accumulator_maps.md b/docs/dev/engine/data_structures/accumulator_maps.md similarity index 100% rename from docs/engine/data_structures/accumulator_maps.md rename to docs/dev/engine/data_structures/accumulator_maps.md diff --git a/docs/engine/data_structures/accumulators.md b/docs/dev/engine/data_structures/accumulators.md similarity index 100% rename from docs/engine/data_structures/accumulators.md rename to docs/dev/engine/data_structures/accumulators.md diff --git a/docs/engine/data_structures/data_structures.md b/docs/dev/engine/data_structures/data_structures.md similarity index 100% rename from docs/engine/data_structures/data_structures.md rename to docs/dev/engine/data_structures/data_structures.md diff --git a/docs/engine/data_structures/dataset_maps.md b/docs/dev/engine/data_structures/dataset_maps.md similarity index 100% rename from docs/engine/data_structures/dataset_maps.md rename to docs/dev/engine/data_structures/dataset_maps.md diff --git a/docs/engine/data_structures/flows_maps.md b/docs/dev/engine/data_structures/flows_maps.md similarity index 100% rename from docs/engine/data_structures/flows_maps.md rename to docs/dev/engine/data_structures/flows_maps.md diff --git a/docs/engine/data_structures/profile_forecasters.md b/docs/dev/engine/data_structures/profile_forecasters.md similarity index 100% rename from docs/engine/data_structures/profile_forecasters.md rename to docs/dev/engine/data_structures/profile_forecasters.md diff --git a/docs/engine/data_structures/profile_pointers.md b/docs/dev/engine/data_structures/profile_pointers.md similarity index 100% rename from docs/engine/data_structures/profile_pointers.md rename to docs/dev/engine/data_structures/profile_pointers.md diff --git a/docs/engine/data_structures/time_series.md b/docs/dev/engine/data_structures/time_series.md similarity index 100% rename from docs/engine/data_structures/time_series.md rename to docs/dev/engine/data_structures/time_series.md diff --git a/docs/engine/data_structures/value_maps.md b/docs/dev/engine/data_structures/value_maps.md similarity index 100% rename from docs/engine/data_structures/value_maps.md rename to docs/dev/engine/data_structures/value_maps.md diff --git a/docs/engine/energy_assets.md b/docs/dev/engine/energy_assets.md similarity index 100% rename from docs/engine/energy_assets.md rename to docs/dev/engine/energy_assets.md diff --git a/docs/engine/energy_carriers.md b/docs/dev/engine/energy_carriers.md similarity index 100% rename from docs/engine/energy_carriers.md rename to docs/dev/engine/energy_carriers.md diff --git a/docs/engine/energy_coops.md b/docs/dev/engine/energy_coops.md similarity index 100% rename from docs/engine/energy_coops.md rename to docs/dev/engine/energy_coops.md diff --git a/docs/engine/energy_data.md b/docs/dev/engine/energy_data.md similarity index 100% rename from docs/engine/energy_data.md rename to docs/dev/engine/energy_data.md diff --git a/docs/engine/energy_management_systems.md b/docs/dev/engine/energy_management_systems.md similarity index 100% rename from docs/engine/energy_management_systems.md rename to docs/dev/engine/energy_management_systems.md diff --git a/docs/engine/energy_model.md b/docs/dev/engine/energy_model.md similarity index 100% rename from docs/engine/energy_model.md rename to docs/dev/engine/energy_model.md diff --git a/docs/engine/grid_connections.md b/docs/dev/engine/grid_connections.md similarity index 100% rename from docs/engine/grid_connections.md rename to docs/dev/engine/grid_connections.md diff --git a/docs/engine/grid_nodes.md b/docs/dev/engine/grid_nodes.md similarity index 100% rename from docs/engine/grid_nodes.md rename to docs/dev/engine/grid_nodes.md diff --git a/docs/engine/option_lists.md b/docs/dev/engine/option_lists.md similarity index 100% rename from docs/engine/option_lists.md rename to docs/dev/engine/option_lists.md diff --git a/docs/engine/overview.md b/docs/dev/engine/overview.md similarity index 100% rename from docs/engine/overview.md rename to docs/dev/engine/overview.md diff --git a/docs/interface/overview.md b/docs/dev/interface/overview.md similarity index 100% rename from docs/interface/overview.md rename to docs/dev/interface/overview.md diff --git a/docs/loader/lombok/agent-imports-section.webp b/docs/dev/loader/lombok/agent-imports-section.webp similarity index 100% rename from docs/loader/lombok/agent-imports-section.webp rename to docs/dev/loader/lombok/agent-imports-section.webp diff --git a/docs/loader/lombok/lombok.md b/docs/dev/loader/lombok/lombok.md similarity index 100% rename from docs/loader/lombok/lombok.md rename to docs/dev/loader/lombok/lombok.md diff --git a/docs/loader/lombok/project-dependencies.webp b/docs/dev/loader/lombok/project-dependencies.webp similarity index 100% rename from docs/loader/lombok/project-dependencies.webp rename to docs/dev/loader/lombok/project-dependencies.webp diff --git a/docs/loader/lombok/use-agent-builder.webp b/docs/dev/loader/lombok/use-agent-builder.webp similarity index 100% rename from docs/loader/lombok/use-agent-builder.webp rename to docs/dev/loader/lombok/use-agent-builder.webp diff --git a/docs/loader/overview.md b/docs/dev/loader/overview.md similarity index 100% rename from docs/loader/overview.md rename to docs/dev/loader/overview.md diff --git a/docs/resultsUI/overview.md b/docs/dev/resultsUI/overview.md similarity index 100% rename from docs/resultsUI/overview.md rename to docs/dev/resultsUI/overview.md diff --git a/docs/index.md b/docs/index.md index 02d2410..9cafcfe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,9 +22,9 @@ The duration of the simulation can be changed, but simulations longer than one y Every LUX model consists of 4 packages. -* Engine: [Docs](engine/overview.md), [Github](https://github.com/Zenmo/zero_engine) -* Loader/Interface: [Docs](loader/overview.md), [Github](https://github.com/Zenmo/zero_Interface-Loader) -* ResultsUI: [Docs](resultsUI/overview.md), [Github](https://github.com/Zenmo/zero_results_UI) +* Engine: [Docs](dev/engine/overview.md), [Github](https://github.com/Zenmo/zero_engine) +* Loader/Interface: [Docs](dev/loader/overview.md), [Github](https://github.com/Zenmo/zero_Interface-Loader) +* ResultsUI: [Docs](dev/resultsUI/overview.md), [Github](https://github.com/Zenmo/zero_results_UI) * Project: [Docs](?), [Github](https://github.com/Zenmo/LUX_ProjectTemplate) The first three are public repositories that need not be altered for standard models. The fourth is a project specific package. These are not made public because of the sensitive data they contain. A template is made available that can be cloned and set up for your own projects. \ No newline at end of file diff --git a/docs/user/data/businesspark.md b/docs/user/data/businesspark.md new file mode 100644 index 0000000..67e4169 --- /dev/null +++ b/docs/user/data/businesspark.md @@ -0,0 +1 @@ +# Businesspark Input Data Requirements diff --git a/docs/user/data/neighborhood.md b/docs/user/data/neighborhood.md new file mode 100644 index 0000000..48778ce --- /dev/null +++ b/docs/user/data/neighborhood.md @@ -0,0 +1 @@ +# Neighborhood Input Data Requirements diff --git a/docs/user/data/region.md b/docs/user/data/region.md new file mode 100644 index 0000000..d6a0cdf --- /dev/null +++ b/docs/user/data/region.md @@ -0,0 +1 @@ +# Region Input Data Requirements diff --git a/docs/user/limitations.md b/docs/user/limitations.md new file mode 100644 index 0000000..8a429c0 --- /dev/null +++ b/docs/user/limitations.md @@ -0,0 +1 @@ +# Limitations & Known Issues diff --git a/docs/user/project-types.md b/docs/user/project-types.md new file mode 100644 index 0000000..b8a90e8 --- /dev/null +++ b/docs/user/project-types.md @@ -0,0 +1 @@ +# Project Types diff --git a/docs/user/results.md b/docs/user/results.md new file mode 100644 index 0000000..60a785c --- /dev/null +++ b/docs/user/results.md @@ -0,0 +1 @@ +# Interpreting Results diff --git a/docs/user/tutorial.md b/docs/user/tutorial.md new file mode 100644 index 0000000..91c46cb --- /dev/null +++ b/docs/user/tutorial.md @@ -0,0 +1 @@ +# UI Tutorial \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 10dfe61..45bdfe6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,35 +1,48 @@ site_name: LUX Model Documentation nav: - - Home: index.md - - Engine: - - Overview: engine/overview.md - - Grid Nodes: engine/grid_nodes.md - - Grid Connections: engine/grid_connections.md - - Energy Cooperatives: engine/energy_coops.md - - Energy Assets: engine/energy_assets.md - - Consistency Checks: engine/consistency_checks.md - - Energy Management Systems: engine/energy_management_systems.md - - Option Lists: engine/option_lists.md - - Energy Carriers: engine/energy_carriers.md - - Energy Model: engine/energy_model.md - - Energy Data: engine/energy_data.md - - Data Structures: - - Overview: engine/data_structures/data_structures.md - - Time Series: engine/data_structures/time_series.md - - Accumulators: engine/data_structures/accumulators.md - - Accumulator Maps: engine/data_structures/accumulator_maps.md - - Value Maps: engine/data_structures/value_maps.md - - Flows Maps: engine/data_structures/flows_maps.md - - DataSet Maps: engine/data_structures/dataset_maps.md - - Profile Pointers: engine/data_structures/profile_pointers.md - - Profile Forecasters: engine/data_structures/profile_forecasters.md - - Loader: - - Overview: loader/overview.md - - Lombok: loader/lombok/lombok.md - - Interface: - - Overview: interface/overview.md - - ResultsUI: - - Overview: resultsUI/overview.md + - Getting started: index.md + - Model assumptions: assumptions.md + - User guide: + - Project types: user/project-types.md + - UI tutorial: user/tutorial.md + - Input data requirements: + - Neighborhood: user/data/neighborhood.md + - Businesspark: user/data/businesspark.md + - Region: user/data/region.md + - Interpreting results: user/results.md + - Limitations & known issues: user/limitations.md + + - Developer guide: + - Architecture overview: dev/architecture.md + - Engine: + - Overview: dev/engine/overview.md + - Grid Nodes: dev/engine/grid_nodes.md + - Grid Connections: dev/engine/grid_connections.md + - Energy Cooperatives: dev/engine/energy_coops.md + - Energy Assets: dev/engine/energy_assets.md + - Consistency Checks: dev/engine/consistency_checks.md + - Energy Management Systems: dev/engine/energy_management_systems.md + - Option Lists: dev/engine/option_lists.md + - Energy Carriers: dev/engine/energy_carriers.md + - Energy Model: dev/engine/energy_model.md + - Energy Data: dev/engine/energy_data.md + - Data Structures: + - Overview: dev/engine/data_structures/data_structures.md + - Time Series: dev/engine/data_structures/time_series.md + - Accumulators: dev/engine/data_structures/accumulators.md + - Accumulator Maps: dev/engine/data_structures/accumulator_maps.md + - Value Maps: dev/engine/data_structures/value_maps.md + - Flows Maps: dev/engine/data_structures/flows_maps.md + - DataSet Maps: dev/engine/data_structures/dataset_maps.md + - Profile Pointers: dev/engine/data_structures/profile_pointers.md + - Profile Forecasters: dev/engine/data_structures/profile_forecasters.md + - Loader: + - Overview: dev/loader/overview.md + - Lombok: dev/loader/lombok/lombok.md + - Interface: + - Overview: dev/interface/overview.md + - ResultsUI: + - Overview: dev/resultsUI/overview.md theme: readthedocs markdown_extensions: