diff --git a/docs/source/api_bare_metal_compute_service.rst b/docs/source/api_bare_metal_compute_service.rst index 71304e2..fe07d8f 100755 --- a/docs/source/api_bare_metal_compute_service.rst +++ b/docs/source/api_bare_metal_compute_service.rst @@ -5,3 +5,4 @@ wrench.bare_metal_compute_service :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_cloud_compute_service.rst b/docs/source/api_cloud_compute_service.rst index 54bf348..594b93b 100755 --- a/docs/source/api_cloud_compute_service.rst +++ b/docs/source/api_cloud_compute_service.rst @@ -5,3 +5,4 @@ wrench.cloud_compute_service :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_compute_service.rst b/docs/source/api_compute_service.rst index bc51292..42373a3 100755 --- a/docs/source/api_compute_service.rst +++ b/docs/source/api_compute_service.rst @@ -5,3 +5,4 @@ wrench.compute_service :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_file.rst b/docs/source/api_file.rst index 3f486e6..c5c0a8d 100755 --- a/docs/source/api_file.rst +++ b/docs/source/api_file.rst @@ -5,3 +5,4 @@ wrench.file :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_simulation.rst b/docs/source/api_simulation.rst index ef69653..a4be630 100755 --- a/docs/source/api_simulation.rst +++ b/docs/source/api_simulation.rst @@ -5,3 +5,4 @@ wrench.simulation :show-inheritance: :members: :exclude-members: add_input_file,add_output_file,create_vm,destroy_vm,get_task_input_files,get_task_output_files,is_vm_down,is_vm_running,is_vm_suspended,lookup_file_at_storage_service,resume_vm,shutdown_vm,standard_job_get_tasks,start_vm,submit_standard_job,supports_compound_jobs,supports_pilot_jobs,supports_standard_jobs,suspend_vm,task_get_end_date,task_get_flops,task_get_max_num_cores,task_get_memory,task_get_min_num_cores,task_get_start_date + :inherited-members: diff --git a/docs/source/api_simulation_item.rst b/docs/source/api_simulation_item.rst index f30c915..cb1c2b5 100755 --- a/docs/source/api_simulation_item.rst +++ b/docs/source/api_simulation_item.rst @@ -4,3 +4,4 @@ wrench.simulation_item .. automodule:: wrench.simulation_item :members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_standard_job.rst b/docs/source/api_standard_job.rst index a620e4a..3c1768a 100755 --- a/docs/source/api_standard_job.rst +++ b/docs/source/api_standard_job.rst @@ -5,3 +5,4 @@ wrench.standard_job :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_storage_service.rst b/docs/source/api_storage_service.rst index 2400a24..0390520 100755 --- a/docs/source/api_storage_service.rst +++ b/docs/source/api_storage_service.rst @@ -5,3 +5,4 @@ wrench.storage_service :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_task.rst b/docs/source/api_task.rst index fca986e..5d86cee 100755 --- a/docs/source/api_task.rst +++ b/docs/source/api_task.rst @@ -5,3 +5,4 @@ wrench.task :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_virtual_machine.rst b/docs/source/api_virtual_machine.rst index 0f897c3..86b6680 100755 --- a/docs/source/api_virtual_machine.rst +++ b/docs/source/api_virtual_machine.rst @@ -5,3 +5,4 @@ wrench.virtual_machine :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/docs/source/api_workflow.rst b/docs/source/api_workflow.rst index 7ec2866..454f3c5 100755 --- a/docs/source/api_workflow.rst +++ b/docs/source/api_workflow.rst @@ -5,3 +5,4 @@ wrench.workflow :members: :undoc-members: :show-inheritance: + :inherited-members: diff --git a/wrench/bare_metal_compute_service.py b/wrench/bare_metal_compute_service.py index bde0d59..ff35e43 100755 --- a/wrench/bare_metal_compute_service.py +++ b/wrench/bare_metal_compute_service.py @@ -30,7 +30,7 @@ def __init__(self, simulation, name: str) -> None: def submit_standard_job(self, standard_job: StandardJob) -> None: """ - Submit a standard job to a bare-metal compute service + Submit a standard job to the compute service :param standard_job: the standard job :type standard_job: StandardJob diff --git a/wrench/cloud_compute_service.py b/wrench/cloud_compute_service.py index 1aad9a1..841da6f 100755 --- a/wrench/cloud_compute_service.py +++ b/wrench/cloud_compute_service.py @@ -31,7 +31,7 @@ def __init__(self, simulation, name: str) -> None: def create_vm(self, num_cores: int, ram_memory: float, property_list: dict[str, str], message_payload_list: dict[str, float]) -> VirtualMachine: """ - Create a new virtual machine instance on a cloud compute service + Create a new virtual machine instance on the compute service :param num_cores: number of cores in the virtual machine :type num_cores: int @@ -48,7 +48,7 @@ def create_vm(self, num_cores: int, ram_memory: float, property_list: dict[str, def destroy_vm(self, vm: VirtualMachine) -> None: """ - Create a new virtual machine instance on a cloud compute service + Destroy a new virtual machine instance on the compute service :param vm: A virtual machine :type vm: VirtualMachine @@ -57,7 +57,7 @@ def destroy_vm(self, vm: VirtualMachine) -> None: def __str__(self) -> str: """ - :return: String representation of a cloud compute service + :return: String representation of a the compute service :rtype: str """ s = f"Compute Service {self.name}" diff --git a/wrench/compute_service.py b/wrench/compute_service.py index 3415e6b..4d98f3a 100755 --- a/wrench/compute_service.py +++ b/wrench/compute_service.py @@ -29,7 +29,7 @@ def __init__(self, simulation, name: str) -> None: def supports_compound_jobs(self) -> bool: """ - Determines whether the compute service supports compound jobs. + Determine whether the compute service supports compound jobs :return: True if compound jobs are supported, false otherwise :rtype: bool @@ -38,7 +38,7 @@ def supports_compound_jobs(self) -> bool: def supports_pilot_jobs(self) -> bool: """ - Determines whether the compute service supports pilot jobs. + Determine whether the compute service supports pilot jobs :return: True if pilot jobs are supported, false otherwise :rtype: bool @@ -47,7 +47,7 @@ def supports_pilot_jobs(self) -> bool: def supports_standard_jobs(self) -> bool: """ - Determines whether the compute service supports standard jobs. + Determine whether the compute service supports standard jobs :return: True if standard jobs are supported, false otherwise :rtype: bool diff --git a/wrench/simulation.py b/wrench/simulation.py index b0346fc..36dcaec 100755 --- a/wrench/simulation.py +++ b/wrench/simulation.py @@ -160,7 +160,7 @@ def get_simulation_events(self) -> List[Dict[str, Union[str, StandardJob, Comput def create_standard_job(self, tasks: List[Task], file_locations: dict[File, StorageService]) -> StandardJob: """ - Create a one-task standard job + Create a standard job :param tasks: list of tasks :type tasks: List[Task] @@ -455,6 +455,7 @@ def create_workflow_from_json(self, json_object: json, reference_flop_rate: str, ignore_avg_cpu: bool, show_warnings: bool) -> Workflow: """ Create a workflow from a JSON file + :param json_object: A JSON object created from a WfCommons JSON file :type json_object: json :param reference_flop_rate: reference flop rate diff --git a/wrench/simulation_item.py b/wrench/simulation_item.py index da57676..735fc93 100755 --- a/wrench/simulation_item.py +++ b/wrench/simulation_item.py @@ -28,6 +28,6 @@ def __init__(self, simulation, name: str) -> None: def get_name(self) -> str: """ - Get the simulation item name + Get the name """ return self.name diff --git a/wrench/standard_job.py b/wrench/standard_job.py index c25c1f4..163744b 100755 --- a/wrench/standard_job.py +++ b/wrench/standard_job.py @@ -35,7 +35,7 @@ def __init__(self, simulation, name: str, tasks: List[Task]) -> None: def get_tasks(self) -> List[Task]: """ - Get the number of tasks in a standard job + Get the list of tasks in the job :return: a list of task objects :rtype: List[Task] diff --git a/wrench/storage_service.py b/wrench/storage_service.py index 9e10f26..998ff99 100755 --- a/wrench/storage_service.py +++ b/wrench/storage_service.py @@ -30,7 +30,7 @@ def __init__(self, simulation, name: str) -> None: def create_file_copy(self, file: File) -> None: """ - Creates a copy of a file (ex nihilo) at this storage service + Create a copy of a file (ex nihilo) at the storage service :param file: the file """ @@ -38,7 +38,7 @@ def create_file_copy(self, file: File) -> None: def lookup_file(self, file: File) -> bool: """ - Checks whether a copy of a file is stored on the storage service + Check whether a copy of a file is stored on the storage service :param file: the file :return: true or false diff --git a/wrench/virtual_machine.py b/wrench/virtual_machine.py index a7bb573..6ce763e 100755 --- a/wrench/virtual_machine.py +++ b/wrench/virtual_machine.py @@ -20,7 +20,7 @@ class VirtualMachine(SimulationItem): """ - WRENCH Virtual Machine class. + WRENCH Virtual Machine class """ def __init__(self, simulation, cloud_compute_service: CloudComputeService, name: str) -> None: @@ -31,7 +31,7 @@ def __init__(self, simulation, cloud_compute_service: CloudComputeService, name: :type simulation :param cloud_compute_service: the cloud compute service :type cloud_compute_service: CloudComputeService - :param name: virtual machine name + :param name: VM name :type name: str """ super().__init__(simulation, name) @@ -57,52 +57,52 @@ def start(self) -> BareMetalComputeService: def suspend(self) -> None: """ - Suspends a virtual machine. + Suspend the VM """ return self.simulation._suspend_vm(self) def resume(self) -> None: """ - Resumes a virtual machine. + Resume the VM """ return self.simulation._resume_vm(self) def shutdown(self) -> None: """ - Shuts down a virtual machine. + Shutdown the VM """ return self.simulation._shutdown_vm(self) def is_running(self) -> bool: """ - Determines whether a virtual machine is running. + Determine whether the VM is running - :return: True if the virtual machine is running, false otherwise + :return: True if the VM is running, false otherwise :rtype: bool """ return self.simulation._is_vm_running(self) def is_suspended(self) -> bool: """ - Determines whether a virtual machine is suspended. + Determine whether the VM is suspended - :return: True if the virtual machine is suspended, false otherwise + :return: True if the VM is suspended, false otherwise :rtype: bool """ return self.simulation._is_vm_suspended(self) def is_down(self) -> bool: """ - Determines whether a virtual machine is down. + Determine whether the VM is down - :return: True if the virtual machine is down, false otherwise + :return: True if the VM is down, false otherwise :rtype: bool """ return self.simulation._is_vm_down(self) def __str__(self) -> str: """ - :return: String representation of a virtual machine + :return: String representation of the VM :rtype: str """ s = f"Virtual Machine {self.name} on Cloud Compute Service {self.get_cloud_compute_service().get_name()}" diff --git a/wrench/workflow.py b/wrench/workflow.py index 8fd5585..55209a0 100755 --- a/wrench/workflow.py +++ b/wrench/workflow.py @@ -23,7 +23,7 @@ class Workflow(SimulationItem): """ - WRENCH Workflow class. + WRENCH Workflow class """ def __init__(self, simulation: Simulation, name: str) -> None: