Changelog¶
To update your installation to the latest version use:
pip install up42-py --upgrade
conda update -c conda-forge up42-py
You can determine your currently installed version via:
pip show up42-py
conda search up42-py
Versions¶
0.28.0 (2023-02-17)¶
- Added STAC search functionality to
storage.get_assets.
Now you can filter assets by new parameters:
geometry
,acquired_after
,acquired_before
,collection_names
,producer_names
,tags
,search
,sources
. - Added storage.pystac_client. Use it to authenticate PySTAC client to access your UP42 storage assets using its library.
- Added asset.stac_info. Use it to access STAC metadata, such as acquisition, sensor, and collection information.
0.27.1 (2023-01-26)¶
- Improve error communication of functions using API v2 endpoints.
- add
up42.__version__
attribute to access the package version with Python. - Adapt asset class attributes (
created
tocreatedAt
) to UP42 API.
0.27.0 (2022-12-12)¶
- Add
asset.update_metadata()
for adjusting title & tags of an asset. storage.get_assets()
has new parameterscreated_after
,created_before
,workspace_id
to better filter the desired assets. It now queries the assets of all accessible workspaces by default. Also see docs reference.- Adopt new UP42 API 2.0 endpoints for user storage & assets.
0.26.0 (2022-11-02)¶
- Remove Python version upper bound, this will enable immediate but untested installation with any new Python version.
- Changes to
workflow.construct_parameters
: - Deprecates the
assets
parameter (list of asset objects), instead useasset_ids
(list of asset_ids). - Removes limitation of using only assets originating from blocks, now also supports assets from catalog & tasking.
- In addition to required parameters, now adds all optional parameters that have default values.
tasking.construct_order_parameters
now accepts a Point feature (e.g. use with Blacksky).- Fix:
get_data_products
withbasic=False
now correctly returns only tasking OR catalog products. - The up42 object now correctly does not give access to third party imports anymore (restructured init module).
0.25.0 (2022-10-25)¶
- Add dedicated tasking class for improved handling of satellite tasking orders. See new example in the documentation.
construct_order_parameters
now also adds the parameters specific to the selected data-product, and suggests possible values based on the data-product schema.
0.24.0 (2022-10-20)¶
- Add
catalog.get_data_product_schema()
for details on the order parameters - Switches parameter
sensor
tocollection
incatalog.download_quicklooks
. - Various small improvements e.g. quicklooks automatic band selection, Reduced use of default parameters in constructor methods, error message display, optimized API call handling for parameter validation etc.
- Internal: Separation of Catalog and CatalogBase to prepare addition of Tasking class, reorganize test fixtures.
0.23.1 (2022-10-05)¶
- Fixes issue with filename of downloaded assets containing two suffix
.
e.g../output..zip
. Resolves #350
0.23.0 (2022-09-20)¶
- Integrates the UP42 data products, e.g. the selection "Display" and "Reflectance" configuration in the ordering process. The new ordering process requires the selection of a specific data product, see the updated Search & Order data documentation chapter.
- The
order_parameters
argument forcatalog.estimate_order
andcatalog.place_order
now has a different structure. The previous option to just specify the collection name will soon be deactivated in the UP42 API! - New function
catalog.get_data_products
- New function
catalog.construct_order_parameters
catalog.construct_search_parameters
replacescatalog.construct_parameters
which is deprecated and will be removed in v0.25.0
0.22.2 (2022-07-21)¶
- Fix unpacking of order assets if no output topfolder inherent in archive
0.22.1 (2022-07-19)¶
- Fix conda release (include requirements-viz file)
0.22.0 (2022-07-05)¶
- Adds webhooks functionality to the SDK, see new webhooks docs chapter.
- Introduces optional installation option for the visualization functionalities. The required dependencies are now not installed by default. See the new [visualization docs chapter] (https://sdk.up42.com/visualizations/).
- Removes
order.metadata
property, as removed from UP42 API. - Fix: Using a MultiPolygon geometry in construct_parameters will now correctly raise an error as not accepted.
- Documentation overhaul & various improvements
0.21.0 (2022-05-12)¶
- Adding
up42.get_balance
andup42.get_credits_history
features for allowing account information retrieval. - Adding
up42.get_block_coverage
features for retrieval of the catalog blocks' coverage as geojson. project.get_jobs
now has sorting criteria, sorting order and limit parameters.- Catalog search now enables search for Pleiades Neo etc. (uses host specific API endpoints)
- Fix:
project.get_jobs
now correctly queries the full number of jobs.
0.20.2 (2022-04-10)¶
- Update documentation
- Non functional changes to enable conda release
- Update requirements and removing overlapping subdependencies
0.20.1 (2022-04-05)¶
- Update documentation for latest changes on the user console.
- Remove outdated examples.
- Add required files on the dist version for allowing creation of conda meta files.
0.20.0 (2022-02-15)¶
- Enables getting credits consumed by a job via
job.get_credits
.
0.19.0 (2022-01-28)¶
- Add support for UP42 data collections via
catalog.get_collections
. - Switch
catalog.construct_parameters
to usecollection
instead ofsensor
for the dataset selection. - Refactor retry mechanism. Resolves issue of unintended token renewals & further limits retries.
0.18.1 (2021-12-20)¶
- Allow installation with Python 3.9
0.18.0 (2021-11-10)¶
- Add sorting criteria, sorting order and results limit parameters to
storage.get_orders
andstorage.get_assets
. Now also uses results pagination which avoids timeout issues when querying large asset/order collections. - Significant speed improvement for:
-
.get_jobs
,.get_workflows
,.get_assets
,.get_orders
calls.workflow.create_workflow
when used withexisting=True
.- Printing objects representations, which now does not trigger additional object info API calls.
- Removal: Removes deprecated handling of multiple features as input geometry in
.construct_parameters
Instead, using multiple features or a MultiPolygon will now raise an error. This aligns the Python SDK with the regular UP42 platform behaviour. - Removal: Remove the Python SDK Command Line Interface.
- Fix: JobTask.info and the printout now uses the correct jobtask information.
0.17.0 (2021-09-10)¶
- Adds
usage_type
parameter for selection of "DATA" and "ANALYTICS" data in catalog search. - Adds automatic handling of catalog search results pagination when requesting more than 500 results.
- Adds support for datetime objects and all iso-format compatible time strings to
construct_parameters
. - Fix:
get_compatible_blocks
with an empty workflow now returns all data blocks. - Start deprecation for
handle_multiple_features
parameter inconstruct_parameters
to guarantee parity with UP42 platform. In the future, the UP42 SDK will only handle single geometries. - Uses Oauth for access token handling.
0.16.0 (2021-06-30)¶
- Limit memory usage for large file downloads (#237)
- Remove deprecated job.get_status() (Replace by job.status) (#224)
- Remove deprecated jobcollection.get_job_info() and jobcollection.get_status() (Replaced by jobcollection.info and jobcollection.status)
- Remove order-id functionality (#228)
- Limit installation to Python <=3.9.4
- Internal code improvements (e.g. project settings, retry)
0.15.2 (2021-04-07)¶
- Enables plotting of jobcollection with
.map_results()
. - Fixes
.cancel_job()
functionality.
0.15.1 (2020-03-12)¶
- Fixes breaking API change in catalog search.
- Catalog search result now contains a
sceneId
property instead ofscene_id
.
0.15.0 (2020-01-27)¶
- Add
Storage
,Order
andAsset
objects. - Add possibility to create orders from
Catalog
withCatalog.place_order
. - Add possibility to use assets in job parameters with
Workflow.construct_paramaters
. - Update job estimation endpoint.
- Multiple documentation fixes.
0.14.0 (2020-12-07)¶
- Add
workflow.estimate_job()
function for estimation of credit costs & job duration before running a job. - Add
bands=[3,2,1]
parameter in.plot_results()
and.map_results()
for band & band order selection. .plot_results()
now accepts kwargs of rasterio.plot.show and matplotlib.- Add
up42.initialize_jobcollection()
- Add
get_estimation=False
parameter toworkflow.test_job
. - Add ship-identification example.
- Overhaul "Getting started" examples.
0.13.1 (2020-11-18)¶
- Handle request rate limits via retry mechanism.
- Limit
map_quicklooks()
to 100 quicklooks. - Add aircraft detection example & documentation improvements.
0.13.0 (2020-10-30)¶
- New consistent use & documentation of the basic functionality:
- All basic functions (e.g.
up42.get_blocks
) are accessible from theup42
import object. Now consistently documented in theup42
object code reference. - The option to use this basic functionality from any lower level object will soon be
removed (e.g.
project.get_blocks
,workflow.get_blocks
). Now triggers a deprecation warning.
- All basic functions (e.g.
- The plotting functionality of each object is now documented directly in that object's code reference.
- Fix: Repair catalog search for sobloo.
- Various improvements to docs & code reference.
- Overhaul & simplify test fixtures.
- Split off viztools module from tools module.
0.12.0 (2020-10-14)¶
- Simplify object representation, also simplifies logger messages.
- Add
.info
property to all objects to get the detailed object information, deprecation process for.get_info
. - Add
.status
property to job, jobtask and jobcollection objects. Deprecation process for.get_status
. - Add selection of job mode for
.get_jobs
. - Add description of initialization of each object to code reference.
- Fix: Use correct cutoff time 23:59:59 in default datetimes.
- Fix: Download jobtasks to respective jobtask subfolders instead of the job folder.
- Unpin geopandas version in requirements.
- Move sdk documentation to custom subdomain "sdk.up42.com".
- Simplify mock tests & test fixtures
0.11.0 (2020-08-13)¶
- Fix: Remove buffer 0 for fixing invalid geometry.
- Add
.map_quicklooks
method for visualising quicklooks interactively. - Add an example notebook for mapping quicklooks using
.map_quicklooks
method.
0.10.1 (2020-08-13)¶
- Hotfix: Fixes usage of multiple features as the input geometry.
0.10.0 (2020-08-07)¶
- Add parallel jobs feature. Allows running jobs for multiple geometries, scene_ids or
timeperiods in parallel. Adds
workflow.construct_parameters_parallel
,workflow.test_job_parallel
,workflow.run_job_parallel
and the newJobCollection
object. - Adjusts
workflow.get_jobs
andproject.get_jobs
to return JobCollections. - Adjusts airports-parallel example notebook to use the parallel jobs feature.
- Adjusts flood mapping example notebook to use OSM block.
- Adds option to not unpack results in
job.download_results
. - Now allows passing only scene_ids to
workflow.construct_parameters
. - Improves layout of image results plots for multiple results.
- Added binder links.
- Now truncates log messages > 2k characters.
- Various small improvements & code refactorings.
0.9.3 (2020-07-15)¶
- Add support for secondary geojson file to
job.map_results
0.9.2 (2020-07-04)¶
- Fix inconsistency with
job.map_results
selecting the json instead of the image
0.9.1 (2020-06-25)¶
- Fixes typo in catalog search parameters
0.9.0 (2020-05-07)¶
- Enable block_name and block_display_name for
workflow.add_workflow_tasks
- Replace requirement to specify provider by sensor for
catalog.download_quicklooks
- Add option to disable logging in
up42.settings
- Add
project.get_jobs
and limitworkflow.get_jobs
to jobs in the workflow. - Fix download of all output files
- Job name selectabable in
workflow.test_job
andworkflow.run_job
(with added suffix _py) - Fix crs issues in make
job.map_results
, make plotting functionalities more robust
0.8.3 (2020-04-30)¶
- Pin geopandas to 0.7.0, package requires new crs convention
0.8.2 (2020-04-27)¶
- Removed
job.create_and_run_job
, now split intojob.test_job
andjob.run_job