Index

_

__init__() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method) (ionworks.client.Ionworks method) (ionworks.errors.IonworksError method) (ionworks.job.JobClient method) (ionworks.pipeline.PipelineClient method) (ionworks.simulation.SimulationClient method) (ionworks.validators.MeasurementValidationError method)

B

bounds_tuple_validator() (in module ionworks.validators)

BuiltInEntryConfig (class in ionworks.pipeline)

C

calculation (ionworks.pipeline.CalculationConfig attribute) CalculationConfig (class in ionworks.pipeline) CalculationResponse (class in ionworks.pipeline) callback_url (ionworks.job.JobCreationPayload attribute) cancel() (ionworks.job.JobClient method) capabilities() (ionworks.client.Ionworks method) capacity (ionworks.simulation.QuickModelConfig attribute) cell_instance_id (ionworks.models.CellMeasurement attribute) cell_specification_id (ionworks.models.CellInstance attribute) CellInstance (class in ionworks.models) CellInstanceClient (class in ionworks.cell_instance) CellInstanceDetail (class in ionworks.models) CellMeasurement (class in ionworks.models) CellMeasurementBundleResponse (class in ionworks.models) CellMeasurementClient (class in ionworks.cell_measurement) CellMeasurementDetail (class in ionworks.models) CellSpecification (class in ionworks.models) CellSpecificationClient (class in ionworks.cell_specification)

chemistry (ionworks.simulation.QuickModelConfig attribute) ConfirmUploadResponse (class in ionworks.models) convert_dict_to_df() (ionworks.models.CellMeasurementDetail class method) (ionworks.models.StepsAndCycles class method) cost (ionworks.pipeline.DataFitConfig attribute) count (ionworks.simulation.DesignParametersDOE attribute) (ionworks.simulation.DOERow attribute) create() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method) (ionworks.job.JobClient method) (ionworks.pipeline.PipelineClient method) create_or_get() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method) created_at (ionworks.job.JobResponse attribute) cycles (ionworks.models.CellMeasurementDetail attribute) (ionworks.models.StepsAndCycles attribute) cycles() (ionworks.cell_measurement.CellMeasurementClient method)

D

data (ionworks.errors.IonworksError attribute) DataFitConfig (class in ionworks.pipeline) DataFitResponse (class in ionworks.pipeline) delete() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method) (ionworks.client.Ionworks method) description (ionworks.pipeline.PipelineConfig attribute) (ionworks.pipeline.PipelineSubmissionResponse attribute)

design_parameters (ionworks.simulation.ProtocolSimulationRequest attribute) design_parameters_doe (ionworks.simulation.ProtocolSimulationBatchRequest attribute) DesignParametersDOE (class in ionworks.simulation) detail() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) df_to_dict_validator() (in module ionworks.validators) dict_to_df_validator() (in module ionworks.validators) DOERow (class in ionworks.simulation)

E

electrode (ionworks.pipeline.CalculationConfig attribute) element_results (ionworks.pipeline.PipelineResponse attribute) elements (ionworks.pipeline.PipelineConfig attribute) EntryConfig (class in ionworks.pipeline) EntryResponse (class in ionworks.pipeline) error (ionworks.job.JobResponse attribute) (ionworks.pipeline.PipelineSubmissionResponse attribute)

error_code (ionworks.errors.IonworksError attribute) existing_parameters (ionworks.pipeline.CalculationConfig attribute) (ionworks.pipeline.DataFitConfig attribute) (ionworks.pipeline.ValidationConfig attribute) experiment_parameters (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute) extra_variables (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute)

F

file_path (ionworks.models.CellMeasurementBundleResponse attribute) (ionworks.models.ConfirmUploadResponse attribute)

file_scheme_validator() (in module ionworks.validators) float_sanitizer() (in module ionworks.validators)

G

get() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method) (ionworks.client.Ionworks method) (ionworks.job.JobClient method) (ionworks.pipeline.PipelineClient method) (ionworks.simulation.SimulationClient method)

get_dataframe_backend() (in module ionworks.validators) get_result() (ionworks.simulation.SimulationClient method)

H

health_check() (ionworks.client.Ionworks method)

I

id (ionworks.models.CellInstance attribute) (ionworks.models.CellMeasurement attribute) (ionworks.models.CellSpecification attribute) (ionworks.pipeline.PipelineSubmissionResponse attribute) InitiateUploadResponse (class in ionworks.models) instance (ionworks.models.CellInstanceDetail attribute) (ionworks.models.ConfirmUploadResponse attribute) instance_id (ionworks.models.CellMeasurementDetail attribute) Ionworks (class in ionworks.client) ionworks.cell_instance module ionworks.cell_measurement module ionworks.cell_specification module

ionworks.client module ionworks.errors module ionworks.job module ionworks.models module ionworks.pipeline module ionworks.simulation module ionworks.validators module IonworksError

J

job_id (ionworks.job.JobResponse attribute) (ionworks.simulation.SimulationResponse attribute) job_type (ionworks.job.JobCreationPayload attribute) (ionworks.job.JobResponse attribute)

JobClient (class in ionworks.job) JobCreationPayload (class in ionworks.job) JobResponse (class in ionworks.job)

L

list() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method) (ionworks.job.JobClient method) (ionworks.pipeline.PipelineClient method) (ionworks.simulation.SimulationClient method)

M

max (ionworks.simulation.DOERow attribute) max_backward_jumps (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute) mean (ionworks.simulation.DOERow attribute) measurement (ionworks.models.CellMeasurementBundleResponse attribute) (ionworks.models.CellMeasurementDetail attribute) (ionworks.models.ConfirmUploadResponse attribute) measurement_id (ionworks.models.InitiateUploadResponse attribute) measurements (ionworks.models.CellInstanceDetail attribute) MeasurementValidationError message (ionworks.errors.IonworksError attribute) metadata (ionworks.job.JobResponse attribute) method (ionworks.pipeline.CalculationConfig attribute) min (ionworks.simulation.DOERow attribute) model_config (ionworks.job.JobCreationPayload attribute) (ionworks.job.JobResponse attribute) (ionworks.models.CellInstance attribute) (ionworks.models.CellInstanceDetail attribute) (ionworks.models.CellMeasurement attribute) (ionworks.models.CellMeasurementBundleResponse attribute) (ionworks.models.CellMeasurementDetail attribute) (ionworks.models.CellSpecification attribute) (ionworks.models.ConfirmUploadResponse attribute) (ionworks.models.InitiateUploadResponse attribute) (ionworks.models.StepsAndCycles attribute) (ionworks.pipeline.BuiltInEntryConfig attribute) (ionworks.pipeline.CalculationConfig attribute) (ionworks.pipeline.CalculationResponse attribute) (ionworks.pipeline.DataFitConfig attribute) (ionworks.pipeline.DataFitResponse attribute) (ionworks.pipeline.EntryConfig attribute) (ionworks.pipeline.EntryResponse attribute) (ionworks.pipeline.PipelineConfig attribute) (ionworks.pipeline.PipelineResponse attribute) (ionworks.pipeline.PipelineSubmissionResponse attribute) (ionworks.pipeline.ValidationConfig attribute) (ionworks.pipeline.ValidationResponse attribute) (ionworks.simulation.DesignParametersDOE attribute) (ionworks.simulation.DOERow attribute) (ionworks.simulation.ProtocolExperimentConfig attribute) (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute) (ionworks.simulation.QuickModelConfig attribute) (ionworks.simulation.SimulationResponse attribute)

module ionworks.cell_instance ionworks.cell_measurement ionworks.cell_specification ionworks.client ionworks.errors ionworks.job ionworks.models ionworks.pipeline ionworks.simulation ionworks.validators

N

name (ionworks.models.CellInstance attribute) (ionworks.models.CellMeasurement attribute) (ionworks.models.CellSpecification attribute) (ionworks.pipeline.BuiltInEntryConfig attribute) (ionworks.pipeline.PipelineConfig attribute) (ionworks.pipeline.PipelineSubmissionResponse attribute) (ionworks.simulation.DOERow attribute) (ionworks.simulation.ProtocolExperimentConfig attribute)

O

objectives (ionworks.pipeline.DataFitConfig attribute) (ionworks.pipeline.ValidationConfig attribute)

optimizer (ionworks.pipeline.DataFitConfig attribute) options (ionworks.pipeline.PipelineConfig attribute)

P

parameter_validator() (in module ionworks.validators) parameter_values (ionworks.pipeline.CalculationResponse attribute) (ionworks.pipeline.DataFitResponse attribute) (ionworks.pipeline.EntryResponse attribute) parameterized_model (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute) parameters (ionworks.pipeline.DataFitConfig attribute) params (ionworks.job.JobCreationPayload attribute) (ionworks.job.JobResponse attribute) path (ionworks.models.InitiateUploadResponse attribute) PipelineClient (class in ionworks.pipeline) PipelineConfig (class in ionworks.pipeline) PipelineResponse (class in ionworks.pipeline) PipelineSubmissionResponse (class in ionworks.pipeline)

positive_current_is_charge() (in module ionworks.validators) post() (ionworks.client.Ionworks method) priority (ionworks.job.JobCreationPayload attribute) (ionworks.job.JobResponse attribute) project_id (ionworks.pipeline.PipelineConfig attribute) protocol (ionworks.simulation.ProtocolExperimentConfig attribute) protocol() (ionworks.simulation.SimulationClient method) protocol_batch() (ionworks.simulation.SimulationClient method) protocol_experiment (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute) ProtocolExperimentConfig (class in ionworks.simulation) ProtocolSimulationBatchRequest (class in ionworks.simulation) ProtocolSimulationRequest (class in ionworks.simulation) put() (ionworks.client.Ionworks method)

Q

QuickModelConfig (class in ionworks.simulation)

R

request() (ionworks.client.Ionworks method) result (ionworks.job.JobResponse attribute) (ionworks.pipeline.PipelineResponse attribute)

result() (ionworks.pipeline.PipelineClient method) rows (ionworks.simulation.DesignParametersDOE attribute) run_validators_inbound() (in module ionworks.validators) run_validators_outbound() (in module ionworks.validators)

S

sampling (ionworks.simulation.DesignParametersDOE attribute) schema() (ionworks.client.Ionworks method) set_dataframe_backend() (in module ionworks.validators) set_defaults() (ionworks.pipeline.PipelineConfig method) signed_url (ionworks.models.InitiateUploadResponse attribute) simulation_id (ionworks.simulation.SimulationResponse attribute) SimulationClient (class in ionworks.simulation) SimulationResponse (class in ionworks.simulation) specification_id (ionworks.models.CellInstanceDetail attribute) (ionworks.models.CellMeasurementDetail attribute) status (ionworks.job.JobResponse attribute) (ionworks.pipeline.PipelineSubmissionResponse attribute)

status_code (ionworks.errors.IonworksError attribute) std (ionworks.simulation.DOERow attribute) steps (ionworks.models.CellMeasurementDetail attribute) (ionworks.models.StepsAndCycles attribute) steps() (ionworks.cell_measurement.CellMeasurementClient method) steps_and_cycles() (ionworks.cell_measurement.CellMeasurementClient method) steps_created (ionworks.models.CellMeasurementBundleResponse attribute) (ionworks.models.ConfirmUploadResponse attribute) StepsAndCycles (class in ionworks.models) study_id (ionworks.simulation.ProtocolSimulationBatchRequest attribute) (ionworks.simulation.ProtocolSimulationRequest attribute) summary_stats (ionworks.pipeline.ValidationConfig attribute) (ionworks.pipeline.ValidationResponse attribute)

T

time_series (ionworks.models.CellMeasurementDetail attribute) time_series() (ionworks.cell_measurement.CellMeasurementClient method)

token (ionworks.models.InitiateUploadResponse attribute) type (ionworks.simulation.DOERow attribute)

U

update() (ionworks.cell_instance.CellInstanceClient method) (ionworks.cell_measurement.CellMeasurementClient method) (ionworks.cell_specification.CellSpecificationClient method)

updated_at (ionworks.job.JobResponse attribute) UPLOAD_TIMEOUT (ionworks.cell_measurement.CellMeasurementClient attribute)

V

validate_cumulative_values_reset_per_step() (in module ionworks.validators) validate_cycle_constant_within_step() (in module ionworks.validators) validate_elements_format() (ionworks.pipeline.PipelineConfig class method) validate_measurement_data() (in module ionworks.validators) validate_minimum_points_per_step() (in module ionworks.validators) validate_ocp_columns() (in module ionworks.validators) validate_positive_current_is_discharge() (in module ionworks.validators) validate_step_count_sequential() (in module ionworks.validators)

validate_time_monotonic() (in module ionworks.validators) validate_time_series_row_count() (in module ionworks.validators) validate_time_starts_at_zero() (in module ionworks.validators) validation_results (ionworks.pipeline.ValidationResponse attribute) ValidationConfig (class in ionworks.pipeline) ValidationResponse (class in ionworks.pipeline) values (ionworks.pipeline.EntryConfig attribute) (ionworks.simulation.DOERow attribute)

W

wait_for_completion() (ionworks.pipeline.PipelineClient method) (ionworks.simulation.SimulationClient method)