Project¶
The Project is the top-level class of the UP42 hierarchy. With it you can create new workflows, query already existing workflows & jobs in the project and manage the project settings.
Create a new project on the UP42 Console website.
Use an existing project:
up42.authenticate(project_id="uz92-8uo0-4dc9-ab1d-06d7ec1a5321",
project_api_key="9i7uec8a-45be-41ad-a50f-98bewb528b10")
project = up42.initialize_project()
Source code in up42/project.py
13 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 51 52 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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
Attributes¶
info: dict
property
¶
Gets and updates the project metadata information.
max_concurrent_jobs: int
property
¶
Gets the maximum number of concurrent jobs allowed by the project settings.
Functions¶
create_workflow(name, description='', use_existing=False)
¶
Creates a new workflow and returns a workflow object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
Name of the new workflow. |
required |
description |
str
|
Description of the new workflow. |
''
|
use_existing |
bool
|
If True, instead of creating a new workflow, uses the most recent workflow with the same name & description. |
False
|
Returns:
Type | Description |
---|---|
Workflow
|
The workflow object. |
Source code in up42/project.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 91 92 93 94 95 96 97 98 |
|
get_jobs(return_json=False, test_jobs=True, real_jobs=True, limit=500, sortby='createdAt', descending=True)
¶
Get all jobs in the project as a JobCollection or JSON.
Use Workflow().get_job() to get a JobCollection with jobs associated with a specific workflow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
return_json |
bool
|
If true, returns the job info JSONs instead of JobCollection. |
False
|
test_jobs |
bool
|
Return test jobs or test queries. |
True
|
real_jobs |
bool
|
Return real jobs. |
True
|
limit |
int
|
Only return n first jobs by sorting criteria and order, default 500. |
500
|
sortby |
str
|
The sorting criteria, one of "createdAt", "name", "id", "mode", "status", "startedAt", "finishedAt". |
'createdAt'
|
descending |
bool
|
The sorting order, True for descending (default), False for ascending. |
True
|
Returns:
Type | Description |
---|---|
Union[JobCollection, List[dict]]
|
All job objects in a JobCollection, or alternatively the jobs info as JSON. |
Source code in up42/project.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
|
get_project_settings()
¶
Gets the project settings.
Returns:
Type | Description |
---|---|
List[Dict[str, str]]
|
The project settings. |
Source code in up42/project.py
211 212 213 214 215 216 217 218 219 220 221 |
|
get_workflows(return_json=False)
¶
Gets all workflows in a project as workflow objects or JSON.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
return_json |
bool
|
True returns infos of workflows as JSON instead of workflow objects. |
False
|
Returns:
Type | Description |
---|---|
Union[List[Workflow], List[dict]]
|
List of Workflow objects in the project or alternatively JSON info of the workflows. |
Source code in up42/project.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
|
update_project_settings(max_aoi_size=None, max_concurrent_jobs=None, number_of_images=None)
¶
Updates a project's settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_aoi_size |
Optional[int]
|
The maximum area of interest geometry size, from 1-1000 sqkm, default 10 sqkm. |
None
|
max_concurrent_jobs |
Optional[int]
|
The maximum number of concurrent jobs, from 1-10, default 1. |
None
|
number_of_images |
Optional[int]
|
The maximum number of images returned with each job, from 1-20, default 10. |
None
|
Source code in up42/project.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|