CRIPT SDK 0.x.x Release Notes

·

·

CRIPT Development Team

v0.5.0 (2022-09-28)

New features and improvements

  • Added support for simulations via the following:
    • New classes
      • Software
      • Computation
      • ComputationalProcess
      • SoftwareConfiguration
      • Algorithm
      • Parameter
      • ComputationalForcefield
    • New class attributes
      • Experiment – computations and computational_processes
      • Data – computations and computational_process
      • Material – computational_forcefield
      • Property – computations
    • Utilize expanded controlled vocabulary in validation checks.
  • Added files attribute to Equipment class.
  • Created Paginator class to handle raw JSON and object list pagination.
  • Converted parent/child relationship fields to Paginator objects (e.g., collections attribute of the Project class).

Bugfixes

  • notes attribute doesn’t belong in Process class.
  • Inventory description attribute should be changed to notes.

v0.4.7 (2022-09-14)

Bugfixes

  • Project class missing notes attribute.

v0.4.6 (2022-09-07)

New features and improvements

  • Refactor packaging structure.
  • Implement integration tests using Docker image.

v0.4.5 (2022-08-31)

New features and improvements

  • Make Project group attribute optional.
  • Apply max_level argument only to primary nodes.
  • Disaggregate package and API versions.

Bugfixes

  • Error when retrieving a Material from an Inventory by name or Identifier key.

v0.4.3 (2022-08-24)

New features and improvements

  • Add descriptor attribute to Condition class.

Bugfixes

  • API URL’s not being interpreted properly.

v0.4.2 (2022-08-17)

New features and improvements

  • Support the use of UI URL’s for API.get() method.

Bugfixes

  • Auto-populating name attribute of the File model is causing issues.

v0.4.1 (2022-08-10)

New features and improvements

  • Add support for specifying external URL’s as thesource attribute of a File object.
  • Migrate from page number to limit/offset pagination for search results.
  • Add update_existing parameter to API.save method, indicating whether to automatically update existing objects with the same name and parent object.
  • Add citations attibute to Equipment class.
  • Remove external_source attribute from File class.
  • Remove required attribute from all node classes.
  • Remove unique_together attribute from all node classes.

Bugfixes

  • Allow Equipment class to be imported.
  • Fix Process model equipment attribute type checking.

v0.4.0 (2022-08-03)

New features and improvements

  • Add support for new POST-based attribute search functionality.
  • Create Project class
  • Add project attribute to Material, File, and Collection classes
  • Create Equipment class
  • Add equipment attribute to Process class
  • Change data attribute on Property and Condition classes from list to a single item
  • Remove Component class
  • Replace component_id attribute with components and components_relative
  • Add material attribute to Condition class
  • Add notes attribute to Property class
  • Remove ‘sample_prep’ attribute from Data class
  • Add sample_preparation attribute to Property and Data classes

v0.3.1 (2022-07-13)

New features and improvements

  • Changed API class method name: download() -> download_file().
  • Support retrieval of Material objects within an Inventory object by name or position.

Bugfixes

  • API._generate_nodes() attempting to generate empty nodes.

v0.3.0 (2022-07-06)

New features and improvements

  • Added type attribute to Process class.
  • Added uncertainty and uncertainty_type attributes to Quantity class.

v0.2.1 (2022-06-29)

Bugfixes

  • Error raised for properties that do not expect a value.

v0.2.0 (2022-06-22)

New features and improvements

  • Renamed Component class attribute component to material.
  • Renamed Component class attribute component_uid to component_id.
  • Renamed Ingredient class attribute ingredient to material.

Bugfixes

  • Erroneous File nodes are created when raw file uploads fail.

v0.1.1 (2022-06-08)

New features and improvements

  • Define the level to which nested node generation should occur via the max_level parameter of the API class’s get, save and refresh methods.
  • Allow Citation objects to be associated with Property objects.
  • Specify whether to use TLS encryption in an API connection via the tls parameter of the API class’s initializer method.

Bugfixes

  • Inventory objects cannot be created without materials.
  • Citation type attribute is missing a default value.
  • Reference objects cannot be created without defining a DOI.
  • Validation not occurring for Process equipment attribute.
  • Material object contains attributes that are now added as Identifier objects: names, vendor and lot_number.
  • Citation class missing notes attribute.