Surveys
Generate random surveys on grids.
Survey
Bases: BaseModel
A single survey.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ident
|
str
|
survey identifier |
required |
size
|
int
|
survey size |
required |
start_date
|
date
|
Start date for specimen collection |
datetime.date(2024, 3, 1)
|
end_date
|
date
|
End date for specimen collection |
datetime.date(2024, 4, 30)
|
cells
|
Grid[int]
|
survey cells |
<dynamic>
|
Source code in src/snailz/surveys.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
|
max_pollution()
Maximum pollution value in this survey.
Source code in src/snailz/surveys.py
34 35 36 37 |
|
to_csv()
Create a CSV representation of a single survey.
Returns:
Type | Description |
---|---|
str
|
A CSV-formatted string with survey cells. |
Source code in src/snailz/surveys.py
39 40 41 42 43 44 45 46 47 48 49 50 |
|
AllSurveys
Bases: BaseModel
A set of generated surveys.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
items
|
list[Survey]
|
all surveys |
required |
Source code in src/snailz/surveys.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
|
max_pollution()
Maximum cell value of all surveys in this set.
Source code in src/snailz/surveys.py
60 61 62 |
|
generate(params)
staticmethod
Generate random surveys.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
SurveyParams
|
Data generation parameters. |
required |
Returns:
Type | Description |
---|---|
AllSurveys
|
Data model including all surveys. |
Source code in src/snailz/surveys.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
|
_survey_id_generator()
Generate unique ID for a survey.
Returns:
Type | Description |
---|---|
str
|
Candidate ID 'gNNN'. |
Source code in src/snailz/surveys.py
93 94 95 96 97 98 99 100 101 |
|