Skip to content

Commit 085a729

Browse files
bevans2000bevans2000
committed
Create skeleton outline of Concept pages
Part of #7
1 parent e964322 commit 085a729

File tree

13 files changed

+314
-0
lines changed

13 files changed

+314
-0
lines changed

‎content/docs/guide/concepts/_index.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Simulation Concepts
3+
description: Overview of the concepts
4+
weight: 1
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
The Simulation is driven by a [Scenario]({{% ref "#scenarios" %}}) that defines the starting conditions of a Simulation.
11+
12+
## Entities
13+
Time Base Simulation
14+
15+
Event event based
16+
17+
## Scenarios
18+
The Scenario provides the starting condition of a Simulation.
19+
The default installation provide a number of predefined [Scenarios]({{% ref "/docs/definitions/scenario" %}}) as well as the ability for a user to create their own can be created via the Scenario Editor
20+
Each Scenario consists of 2 elements of information that the Simulation uses to build the initial set of entities; one for the exiting Settlements and the other future Settlements.
21+
22+
### Settlements
23+
24+
[Settlements]({{% ref "settlement" %}}) are the cornerstone of the Simulation as they are the main modelled entity. Each settlement that exist in the Scenario is defined as:
25+
26+
- A unique name
27+
- A Settlement Template that specifies the physical layout of the Settlement.
28+
- Location on Mars Surface
29+
- The owning Authority
30+
- Population sizes
31+
- Optional Crew. If a crew is present; it's members will be seeded into the initial Settlement population. There are a number of pre-defined [Crews]({{% ref "/docs/definitions/crew" %}}); in addition new Crews can be created via the Scenario Editor.
32+
33+
34+
### Arriving Settlement Mission
35+
36+
This defines if any new Settlements will be created in the future via a Resupply Mission. Currently there is no limit of the size of the supply mission, e.g. a 20 Building Settlement could arrive in one delivery.
37+
The Resupply stipulates all the existing Settlement details with the additino of the future arrivla in terms of Sols.
38+
39+
## Activities
40+
41+
[Missions]({{% ref "mission" %}})
42+
43+

‎content/docs/guide/concepts/authority.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Reporting Authority
3+
description: Provide the Governance control over Settlements
4+
weight: 25
5+
---
6+
## Overview
7+
The Repority Authority (or Authority) is the governing body that controls one or more Settlements as well as the People & Vehicles contained within.
8+
Each one can define a set of Settlement and Vehicle names to be used as well as a gender ratio of settlers.
9+
There is also a list of Countries that contribute Settlers; each Nation has a set of person name generating native names for Settlers.
10+
11+
An Authority defines the objective/agenda of that Authority with their space missions.
12+
13+
There are a number of preconfigured Reporting Authories provided, [Authories]({{% ref "/docs/definitions/authority" %}})
14+
15+
## Agenda
16+
An agenda provides an objective for the Authority doing space exploration.
17+
For the simulation the agenda influence the types of Missions started by a Settlement.
18+
* Objective - Description of the high level objective.
19+
* Findings - Evidence or information that can help achieve the objective.
20+
* Targets/Capabilities - These are a list of targets that will provide the evidence required. The individual target influence the type of Missions created.

‎content/docs/guide/concepts/building.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Building
3+
description: Buildings within a Settlement
4+
weight: 40
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
[Building Templates]({{% ref "/docs/definitions/building" %}}).
12+
13+
Building Category
14+
15+
Buildings needs [maintenance]({{% ref "maintenance" %}}) to prevent Faults occurring.
16+
17+
## Characteristics
18+
19+
Construction material
20+
- CONCRETE
21+
- INFLATABLE
22+
- PRE_FABRICATED
23+
- SEMI_ENGINEERED
24+
25+
## Functions
26+
A Building provides a number of Functions to the Setttlement. Each Function has a special purpose and confguration set in the associated building template.
27+
28+
### Administration
29+
### Algea Farming
30+
### Astronomical Observatory
31+
### Communication
32+
### Computation
33+
### Cooking
34+
[Food Recipes]({{% ref "/docs/definitions/food" %}}).
35+
36+
### Dining
37+
### Earth Return
38+
### EVA
39+
### Exercise
40+
### Farming
41+
[Crops]({{% ref "/docs/definitions/crop" %}}).
42+
43+
### Fishery
44+
### Food & Dessert Preparation
45+
TBD Link to meals
46+
47+
### Life Support
48+
### Living Accomodation
49+
### Management
50+
### Manufacture
51+
[Processes]({{% ref "/docs/definitions/process" %}}).
52+
53+
### Medical Care
54+
[Treatments]({{% ref "/docs/definitions/treatment" %}}).
55+
56+
### Power Generation
57+
### Power Storage
58+
### Recreation
59+
### Research
60+
### Resource Processing
61+
### Robotic Station
62+
[Robots]({{% ref "robot" %}})
63+
### Storage
64+
[Resources]({{% ref "/docs/definitions/resource" %}}).
65+
66+
### Thermal Generation
67+
68+
### Vehicle Maintenance
69+
[Vehicles]({{% ref "vehicle" %}})
70+
### Waste Processing
71+
72+
## Build a new building
73+
Link to Construction Definitions
74+
[Construction Stages]({{% ref "/docs/definitions/construction" %}}).
75+

‎content/docs/guide/concepts/equipment.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Equipment
3+
description: Used by Workers to complete Tasks
4+
weight: 80
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
12+
## EVA Suit
13+
EVA Suit needs [maintenance]({{% ref "maintenance" %}}) to prevent Faults occurring.
14+
15+
## Containers
16+

‎content/docs/guide/concepts/maintenance.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Maintenance
3+
description: Maintenance and Fault Simulation
4+
weight: 90
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
12+
## Maintenance
13+
14+
[Parts]({{% ref "/docs/definitions/part" %}})
15+
16+
## Faults
17+
18+
[Malfunctions]({{% ref "/docs/definitions/malfunction" %}})
19+

‎content/docs/guide/concepts/mission.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Mission
3+
description: Missions allow Workers to achieve objecttives
4+
weight: 99
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+

‎content/docs/guide/concepts/person.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Person
3+
description: Vehicles travel outside a Settlement
4+
weight: 60
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
12+
A Person is also a [Worker]({{% ref "worker" %}}) to complete Tasks.
13+
14+
## Physical Charactertics
15+
16+
17+
## Health
18+
19+
[Complaint]({{% ref "/docs/definitions/complaint" %}}).
20+
21+
## Settlement Position
22+
23+
### Job
24+
25+
### Shift
26+

‎content/docs/guide/concepts/robot.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Robot
3+
description: Robots can work on Tasks.
4+
weight: 55
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
12+
Robots can act as [Workers]({{% ref "worker" %}}) to complete Tasks and Missions.
13+
## Robot Types
14+

‎content/docs/guide/concepts/settlement.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Settlements
3+
description: Overview of the Settlements
4+
weight: 5
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
12+
Settlements are controlled by a [Reporting Authority]({{% ref "authority" %}}).
13+
14+
Link to Settlement Template Definition
15+
[Settlement Templates]({{% ref "/docs/definitions/settlement" %}}).
16+
17+
## Settlement Components
18+
19+
### Buildings
20+
[Building]({{% ref "building" %}}).
21+
22+
### Population
23+
[Persons]({{% ref "person" %}}).
24+
Persons uses Shifts
25+
Link to Robots &
26+
27+
### Equipment
28+
[Equipment]({{% ref "equipment" %}})
29+
[Vehicle]({{% ref "vehicle" %}})
30+
31+
## Resupply Missions
32+
Link to Resupply Manifest Definitions
33+
[Resupply Manifest]({{% ref "/docs/definitions/manifest" %}}).
34+
35+
## Governance
36+
37+
Roles

‎content/docs/guide/concepts/task.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Task
3+
description: Activites for Workers
4+
weight: 95
5+
---
6+
{{% pageinfo color="info" %}}
7+
This is placeholder content.
8+
{{% /pageinfo %}}
9+
10+
## Overview
11+
12+
Tasks are completed by [Workers]({{% ref "worker" %}}).
13+

0 commit comments

Comments
 (0)