HLD - Shodor

<Project Name> High Level Design (HLD) Document
1. Introduction
Welcome to the Louvre Museum! Here you will see a range of artworks, however because
so many people are touring and we have many pieces of art in the gallery, the traffic might
get heavy.
2. Subject Matter Experts Agreement List
Name
Title/Role
Mandatory
Reviewer (Y/N)
Megan Wu
Developer
Y
Phil List
Supervisor
Y
Amalan Iyengar
Intern-apprentice
wrangler
Y
Mobeen
Mentor
Y
Approved
3. Requirements
Look at the story in the introduction and answer the following questions:
○ What are the characters in the story (the nouns)? These are the agents in the
model.
○ The guests, the pieces of artwork, and curator (the person how counts the
number of happy and unhappy people)
○ Do any of the characters have adjectives describing them? These are the
depictions of the agent. Which agents have multiple depictions and what are
they?
○ The guests have a tolerance number (5-25), a count number that can lead to unhappiness
if it equals their tolerance number, and time step for each piece of art (1-5). Guests either
leave out of frustration (unhappy) or happy if they view over 50% of the art.
○ What activities does each character do? These are behaviors of the agent.
○ The guests
■ 0-4 guests will enter within each time step
■ they will keep track of the number of art they view
■ they will stop moving when next to a piece of art for 1-5 time steps
■ guests will count the number of times they can’t move because someone is in
their way
■ Guests will either leave
● If they view over 50% of the artwork
● Or if guest count number equals their tolerance number (which was
assigned upon entering the museum)
○
Curator
■ Will count the number of happy and unhappy people
■ Add a new piece of art every 24 hours until
● 80% of guests leave unhappy
● or the model runs for 30 days
○ When do the activities take place? Does anything have to be true for the
activity to take place?
○ Guests
■
■
■
■
■
○
Will enter randomly and exit either happy or unhappy
Will keep track of the number of art they have viewed
Will move randomly to try and view 50% of the art displayed
Will stop moving (1-5 time steps) if they are next to a piece of art
Will count how many times they can’t move because someone else is in their
way
Curator
■ Count the number of happy and unhappy guests
■ Add artwork every 24 hours until
● 80% of guests are unhappy
● Or the model runs for 30 days
○ How do the characters do each activity? Describe the behaviors in detail, step
by step.
○ Guests
■ 0-4 guests will enter the gallery every time step
■ A crowd tolerance number (5-25) will be given to them upon entering
■ Move around randomly to try and view over 50% of the art
■ Once they are next to a piece of art, they will stop moving for 1-5 time
steps
■ Keep track of the number of art they have viewed
■ If they see over 50% of the art, they will exit the gallery happy
■ Will count the number of times they can’t move
■ If the count number equals the tolerance number, they guest will exit the gallery
unhappy
○
Curator
■ Will count the number of happy and unhappy people as they exit the gallery
■ Will add one new piece of art every 24 hours until
● 80% of the guests leave unhappy
● or the model runs for 30 days
Based on your answers to these questions, create an outline that describes the
agents in the story. For instance:
a. A [Javascript/Agentsheets] model showing the interactions of agents which
exhibit the following behaviors:
i. Guest Agent (Viewing depiction)
1. Stops moving (1-5 time steps) when next to a piece of art.
2. Keeps track of number of pieces of art they have seen.
ii. Guest Agent (Happy depiction)
1. Views over 50% of art without their count number reaching
their tolerance number.
iii. Guest Agent (Unhappy depiction)
1. Count the number of times they can’t move because someone is in
their way.
2. Leave in frustration if the count number equals their tolerance
number.
iv. Curator
1. Counts the number of guests who leave happy or unhappy.
2. Adds a new piece of art to the gallery every 24 hours until 80% of
guests are unhappy or the model runs for 30 days.
4. Timeline
This is due within five days of receipt of the task (that would be Friday, June 20 for
those receiving this Monday, June 16). It is better to complete this sooner, so that
you can begin implementing an HLD that one of your classmates has written.
5. Desired Behavior / Components
How would you model agent 1 doing behavior 1? Give a step by step explanation of
how each agent does each behavior. Think about how you will demonstrate the
behavior in the AgentSheets model.
Guests
a. Entering randomly 0-4 per time step
b. Be given a crowd tolerance (5-25)
c. Move randomly in any direction (up, down, left, right) to view art
d. Stop moving for (1-5 time steps) when next to a piece of art
e. Keep track of number of art they view
f. Count the number of times you can’t move because someone is in your
way
g. Leave when you see either over 50% of the art
h. Or leave if your count number reaches your tolerance number
2. Curator
a. Count the number of people who leave unhappy and happy
b. Add new piece of art every 24 hours
c. Stop adding piece of art after 80% of guests leave unhappy
d. Or stop when the model runs for 30 days
6. Conclusion
The goal of this activity is to …






Write a clear HLD document
Use AgentSheets skills
Make Decisions
Help build an efficient museum exhibit
Maximize the number of happy people and art displays without compromising foot traffic
Implement a number of guests inside the museum at a given time
The point of modeling this is to maximize profits by letting as many people as possible enter the
museum. However, the people should leave happy in order to maintain a high rating, further
encouraging other tourists to visit The Louvre.