ansys-conceptev-core 0.1.3__tar.gz

ansys_conceptev_core-0.1.3/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of Pyconceptev Core's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and wish to be added to this file
+# please submit a request.
+#
+#
+ANSYS, Inc.

ansys_conceptev_core-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ansys_conceptev_core-0.1.3/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: ansys-conceptev-core
+Version: 0.1.3
+Summary: A Python wrapper for Ansys Conceptev core
+Home-page: https://github.com/ansys/pyconceptev
+License: MIT
+Keywords: Ansys,Concept EV,Electric Powertrain
+Author: ANSYS, Inc.
+Author-email: pyansys.core@ansys.com
+Maintainer: ANSYS, Inc.
+Maintainer-email: pyansys.core@ansys.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: httpx (>=0.26.0,<0.27.0)
+Requires-Dist: importlib-metadata (>=7.0,<8.0) ; python_version < "3.8"
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Project-URL: Documentation, https://conceptev.core.docs.pyansys.com
+Project-URL: Repository, https://github.com/ansys/pyconceptev
+Description-Content-Type: text/x-rst
+
+PyConceptEV
+===========
+|pyansys| |python| |MIT|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/badge/python-3.9+-blue.svg
+   :target: https://www.python.org/downloads/
+   :alt: Python
+
+.. .. |pypi| image:: https://img.shields.io/pypi/v/ansys-conceptev-core.svg?logo=python&logoColor=white
+..    :target: https://pypi.org/project/ansys-conceptev-core
+..    :alt: PyPI
+
+.. .. |downloads| image:: https://img.shields.io/pypi/dm/ansys-conceptev-core.svg
+..    :target: https://pypi.org/project/ansys-conceptev-core/
+..    :alt: PyPI Downloads
+
+.. .. |codecov| image:: https://codecov.io/gh/ansys/pyconceptev/graph/badge.svg?token=UZIC7XT5WE
+..    :target: https://codecov.io/gh/ansys/pyconceptev
+..    :alt: Codecov
+
+.. .. |GH-CI| image:: https://github.com/ansys/pyconceptev/actions/workflows/ci_cd.yml/badge.svg
+..    :target: https://github.com/ansys/pyconceptev/actions/workflows/ci_cd.yml
+..    :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+..    :target: https://github.com/psf/black
+..    :alt: Black
+
+.. .. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyconceptev/main.svg
+..    :target: https://results.pre-commit.ci/latest/github/ansys/pyconceptev/main
+..    :alt: pre-commit.ci
+
+
+Overview
+--------
+
+PyConceptEV is a Python client library for the `Ansys ConceptEV <https://www.ansys.com/products/electronics/ansys-concept-ev>`_
+service, which provides a cloud-based design and simulation platform for the concept design
+of EV powertrains.
+
+Documentation and issues
+------------------------
+
+Documentation for the latest stable release of PyConceptEV is hosted
+at `PyConceptEV documentation <https://conceptev.core.docs.pyansys.com/>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://conceptev.core.docs.pyansys.com/version/stable/getting_started/index.html>`_: Learn
+  how to install PyConceptEV in user mode and quickly begin using it.
+- `User guide <https://conceptev.core.docs.pyansys.com/version/stable/user_guide/index.html>`_: Learn how to
+  configure a PyConceptEV session, get a token, and create a client.
+- `API reference <conceptev.core.docs.pyansys.com/version/stable/api/index.html>`_: Understand how the
+  `Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_ provides for interacting
+  programmatically with PyConcept EV.
+- `Examples <https://conceptev.core.docs.pyansys.com/version/stable/examples/index.html>`_: Explore examples
+  that show how to use PyConceptEV.
+- `Contribute <conceptev.core.docs.pyansys.com/version/stable/contributing.html>`_: Learn how to
+  contribute to the PyConceptEV codebase or documentation.
+
+In the upper right corner of the documentation's title bar, there is an option
+for switching from viewing the documentation for the latest stable release
+to viewing the documentation for the development version or previously
+released versions.
+
+On the `PyConceptEV Issues <https://github.com/ansys/pyconceptev/issues>`_
+page, you can create issues to report bugs and request new features. On the
+`Discussions <https://discuss.ansys.com/>`_ page on the Ansys Developer portal,
+you can post questions, share ideas, and get community feedback.
+
+If you have general questions about the PyAnsys ecosystem, email
+`pyansys.core@ansys.com <pyansys.core@ansys.com>`_. If your
+question is specific to PyConceptEV, ask your question in an issue
+as described in the previous paragraph.
+
+License
+-------
+
+PyConceptEV is licensed under the `MIT License <https://github.com/ansys/pyconceptev/blob/main/LICENSE>`_.
+
+PyConceptEV makes no commercial claim over Ansys whatsoever. This library adds a
+Python interface for `Ansys ConceptEV <https://www.ansys.com/products/electronics/ansys-concept-ev>`_
+without changing the core behavior or license of the original Ansys software.
+

ansys_conceptev_core-0.1.3/README.rst

@@ -0,0 +1,91 @@
+PyConceptEV
+===========
+|pyansys| |python| |MIT|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/badge/python-3.9+-blue.svg
+   :target: https://www.python.org/downloads/
+   :alt: Python
+
+.. .. |pypi| image:: https://img.shields.io/pypi/v/ansys-conceptev-core.svg?logo=python&logoColor=white
+..    :target: https://pypi.org/project/ansys-conceptev-core
+..    :alt: PyPI
+
+.. .. |downloads| image:: https://img.shields.io/pypi/dm/ansys-conceptev-core.svg
+..    :target: https://pypi.org/project/ansys-conceptev-core/
+..    :alt: PyPI Downloads
+
+.. .. |codecov| image:: https://codecov.io/gh/ansys/pyconceptev/graph/badge.svg?token=UZIC7XT5WE
+..    :target: https://codecov.io/gh/ansys/pyconceptev
+..    :alt: Codecov
+
+.. .. |GH-CI| image:: https://github.com/ansys/pyconceptev/actions/workflows/ci_cd.yml/badge.svg
+..    :target: https://github.com/ansys/pyconceptev/actions/workflows/ci_cd.yml
+..    :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+..    :target: https://github.com/psf/black
+..    :alt: Black
+
+.. .. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyconceptev/main.svg
+..    :target: https://results.pre-commit.ci/latest/github/ansys/pyconceptev/main
+..    :alt: pre-commit.ci
+
+
+Overview
+--------
+
+PyConceptEV is a Python client library for the `Ansys ConceptEV <https://www.ansys.com/products/electronics/ansys-concept-ev>`_
+service, which provides a cloud-based design and simulation platform for the concept design
+of EV powertrains.
+
+Documentation and issues
+------------------------
+
+Documentation for the latest stable release of PyConceptEV is hosted
+at `PyConceptEV documentation <https://conceptev.core.docs.pyansys.com/>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://conceptev.core.docs.pyansys.com/version/stable/getting_started/index.html>`_: Learn
+  how to install PyConceptEV in user mode and quickly begin using it.
+- `User guide <https://conceptev.core.docs.pyansys.com/version/stable/user_guide/index.html>`_: Learn how to
+  configure a PyConceptEV session, get a token, and create a client.
+- `API reference <conceptev.core.docs.pyansys.com/version/stable/api/index.html>`_: Understand how the
+  `Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_ provides for interacting
+  programmatically with PyConcept EV.
+- `Examples <https://conceptev.core.docs.pyansys.com/version/stable/examples/index.html>`_: Explore examples
+  that show how to use PyConceptEV.
+- `Contribute <conceptev.core.docs.pyansys.com/version/stable/contributing.html>`_: Learn how to
+  contribute to the PyConceptEV codebase or documentation.
+
+In the upper right corner of the documentation's title bar, there is an option
+for switching from viewing the documentation for the latest stable release
+to viewing the documentation for the development version or previously
+released versions.
+
+On the `PyConceptEV Issues <https://github.com/ansys/pyconceptev/issues>`_
+page, you can create issues to report bugs and request new features. On the
+`Discussions <https://discuss.ansys.com/>`_ page on the Ansys Developer portal,
+you can post questions, share ideas, and get community feedback.
+
+If you have general questions about the PyAnsys ecosystem, email
+`pyansys.core@ansys.com <pyansys.core@ansys.com>`_. If your
+question is specific to PyConceptEV, ask your question in an issue
+as described in the previous paragraph.
+
+License
+-------
+
+PyConceptEV is licensed under the `MIT License <https://github.com/ansys/pyconceptev/blob/main/LICENSE>`_.
+
+PyConceptEV makes no commercial claim over Ansys whatsoever. This library adds a
+Python interface for `Ansys ConceptEV <https://www.ansys.com/products/electronics/ansys-concept-ev>`_
+without changing the core behavior or license of the original Ansys software.

ansys_conceptev_core-0.1.3/pyproject.toml

@@ -0,0 +1,136 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+# Check https://python-poetry.org/docs/pyproject/ for all available sections
+name = "ansys-conceptev-core"
+description = "A Python wrapper for Ansys Conceptev core"
+version = "0.1.3"
+license = "MIT"
+authors = ["ANSYS, Inc. <pyansys.core@ansys.com>"]
+maintainers = ["ANSYS, Inc. <pyansys.core@ansys.com>"]
+repository = "https://github.com/ansys/pyconceptev"
+documentation = "https://conceptev.core.docs.pyansys.com"
+readme = "README.rst"
+keywords = [
+  "Ansys",
+  "Concept EV",
+  "Electric Powertrain",
+]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+packages = [
+    { include = "ansys", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+importlib-metadata = {version = "^7.0", python = "<3.8"}
+python-dotenv = "^1.0.0"
+httpx = "^0.26.0"
+
+# Common packages for test and examples
+[tool.poetry.group.dev.dependencies]
+plotly = "^5.18.0"
+tox = "^4.15.1"
+pytest-cov = "^5.0.0"
+pre-commit = "^3.7.1"
+
+# Optional documentation dependencies
+[tool.poetry.group.doc]
+optional = true
+
+[tool.poetry.group.doc.dependencies]
+ansys-sphinx-theme = "^0.16.5"
+ipython = "^8.1"
+ipywidgets = "^8.1.3"
+jupyterlab = "^4.2.2"
+jupytext = "^1.15"
+nbconvert = "^7.16.4"
+nbsphinx = "^0.9.3"
+numpydoc = "^1.5.0"
+pypandoc = "^1.13"
+recommonmark = "^0.7.1"
+Sphinx = "^7.2.6"
+sphinx-autobuild = "^2024.4.16"
+sphinx-autodoc-typehints = "^2.1.1"
+sphinx-copybutton = "^0.5.1"
+sphinx-design = "^0.6.0"
+
+# Optional testing dependencies
+[tool.poetry.group.tests]
+optional = true
+
+[tool.poetry.group.tests.dependencies]
+pytest = "^8.2.2"
+pytest-cov = "^5.0.0"
+pytest-httpx = "^0.29.0"
+pytest-mock = "^3.12.0"
+
+# Optional build requirements
+[tool.poetry.group.build]
+optional = true
+
+[tool.poetry.group.build.dependencies]
+build = "^1.0.3"
+twine = "^5.0.0"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 100
+default_section = "THIRDPARTY"
+src_paths = ["doc", "src", "tests"]
+skip_gitignore = true
+
+[tool.coverage.run]
+source = ["ansys.conceptev.core"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.towncrier]
+package = "ansys.conceptev.core"
+directory = "doc/changelog.d"
+filename = "doc/source/changelog.rst"
+start_string = ".. towncrier release notes start\n"
+template = "doc/changelog.d/changelog_template.jinja"
+title_format = "`{version} <https://github.com/ansys/pyconceptev/releases/tag/v{version}>`_ - {project_date}"
+issue_format = "`#{issue} <https://github.com/ansys/pyconceptev/pull/{issue}>`_"
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "dependencies"
+name = "Dependencies"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "miscellaneous"
+name = "Miscellaneous"
+showcontent = true

ansys_conceptev_core-0.1.3/src/ansys/conceptev/core/__init__.py

@@ -0,0 +1,29 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Python wrapper for the Ansys ConceptEV service."""
+
+try:
+    import importlib.metadata as importlib_metadata
+except ModuleNotFoundError:
+    import importlib_metadata
+
+__version__ = importlib_metadata.version(__name__.replace(".", "-"))

ansys_conceptev_core-0.1.3/src/ansys/conceptev/core/app.py

@@ -0,0 +1,319 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Simple API client for the Ansys ConceptEV service."""
+
+import datetime
+from json import JSONDecodeError
+import os
+import time
+from typing import Literal
+
+import dotenv
+import httpx
+
+dotenv.load_dotenv()
+
+Router = Literal[
+    "/architectures",
+    "/components",
+    "/components:from_file",
+    "/components:calculate_loss_map",
+    "/configurations",
+    "/configurations:calculate_forces",
+    "/requirements",
+    "/requirements:calculate_examples",
+    "/jobs",
+    "/jobs:start",
+    "/jobs:status",
+    "/jobs:result",
+    "/concepts",
+    "/drive_cycles",
+    "/drive_cycles:from_file",
+    "/health",
+    "/utilities:data_format_version",
+]
+
+
+def get_token() -> str:
+    """Get token from OCM."""
+    username = os.environ["CONCEPTEV_USERNAME"]
+    password = os.environ["CONCEPTEV_PASSWORD"]
+    ocm_url = os.environ["OCM_URL"]
+    response = httpx.post(
+        url=ocm_url + "/auth/login/", json={"emailAddress": username, "password": password}
+    )
+    if response.status_code != 200:
+        raise Exception(f"Failed to get token {response.content}")
+    return response.json()["accessToken"]
+
+
+def get_http_client(token: str, design_instance_id: str | None = None) -> httpx.Client:
+    """Get an HTTP client.
+
+    The HTTP client creates and maintains the connection, which is more performant than
+    re-creating this connection for each call.
+    """
+    base_url = os.environ["CONCEPTEV_URL"]
+    params = None
+    if design_instance_id:
+        params = {"design_instance_id": design_instance_id}
+    return httpx.Client(headers={"Authorization": token}, params=params, base_url=base_url)
+
+
+def process_response(response) -> dict:
+    """Process a response.
+
+    Check the value returned from the API and raise an error if the process is not successful.
+    """
+    if response.status_code == 200 or response.status_code == 201:  # Success
+        try:
+            return response.json()
+        except JSONDecodeError:
+            return response.content
+    raise Exception(f"Response Failed:{response.content}")
+
+
+def get(
+    client: httpx.Client, router: Router, id: str | None = None, params: dict | None = None
+) -> dict:
+    """Send a GET request to the base client.
+
+    This HTTP verb performs the ``GET`` request and adds the route to the base client.
+    """
+    if id:
+        path = "/".join([router, id])
+    else:
+        path = router
+    response = client.get(url=path, params=params)
+    return process_response(response)
+
+
+def post(client: httpx.Client, router: Router, data: dict, params: dict = {}) -> dict:
+    """Send a POST request to the base client.
+
+    This HTTP verb performs the ``POST`` request and adds the route to the base client.
+    """
+    response = client.post(url=router, json=data, params=params)
+    return process_response(response)
+
+
+def delete(client: httpx.Client, router: Router, id: str) -> dict:
+    """Send a DELETE request to the base client.
+
+    This HTTP verb performs the ``DELETE`` request and adds the route to the base client.
+    """
+    path = "/".join([router, id])
+    response = client.delete(url=path)
+    if response.status_code != 204:
+        raise Exception(f"Failed to delete from {router} with ID:{id}.")
+
+
+def put(client: httpx.Client, router: Router, id: str, data: dict) -> dict:
+    """Put/update from the client at the specific route.
+
+    An HTTP verb that performs the ``PUT`` request and adds the route to the base client.
+    """
+    path = "/".join([router, id])
+    response = client.put(url=path, json=data)
+    return process_response(response)
+
+
+def create_new_project(
+    client: httpx.Client,
+    account_id: str,
+    hpc_id: str,
+    title: str,
+    project_goal: str = "Created from the CLI",
+):
+    """Create a project."""
+    osm_url = os.environ["OCM_URL"]
+    token = client.headers["Authorization"]
+    project_data = {
+        "accountId": account_id,
+        "hpcId": hpc_id,
+        "projectTitle": title,
+        "projectGoal": project_goal,
+    }
+    created_project = httpx.post(
+        osm_url + "/project/create", headers={"Authorization": token}, json=project_data
+    )
+    if created_project.status_code != 200 and created_project.status_code != 204:
+        raise Exception(f"Failed to create a project {created_project}.")
+
+    product_ids = httpx.get(osm_url + "/product/list", headers={"Authorization": token})
+    product_id = [
+        product["productId"]
+        for product in product_ids.json()
+        if product["productName"] == "CONCEPTEV"
+    ][0]
+
+    design_data = {
+        "projectId": created_project.json()["projectId"],
+        "productId": product_id,
+        "designTitle": "Branch 1",
+    }
+    created_design = httpx.post(
+        osm_url + "/design/create", headers={"Authorization": token}, json=design_data
+    )
+
+    if created_design.status_code not in (200, 204):
+        raise Exception(f"Failed to create a design on OCM {created_design.content}.")
+
+    user_details = httpx.post(osm_url + "/user/details", headers={"Authorization": token})
+    if user_details.status_code not in (200, 204):
+        raise Exception(f"Failed to get a user details on OCM {user_details}.")
+
+    concept_data = {
+        "capabilities_ids": [],
+        "components_ids": [],
+        "configurations_ids": [],
+        "design_id": created_design.json()["designId"],
+        "design_instance_id": created_design.json()["designInstanceList"][0]["designInstanceId"],
+        "drive_cycles_ids": [],
+        "jobs_ids": [],
+        "name": "Branch 1",
+        "project_id": created_project.json()["projectId"],
+        "requirements_ids": [],
+        "user_id": user_details.json()["userId"],
+    }
+
+    created_concept = post(client, "/concepts", data=concept_data)
+    return created_concept
+
+
+def get_concept_ids(client: httpx.Client):
+    """Get concept IDs."""
+    concepts = get(client, "/concepts")
+    return {concept["name"]: concept["id"] for concept in concepts}
+
+
+def get_account_ids(token: str) -> dict:
+    """Get account IDs."""
+    ocm_url = os.environ["OCM_URL"]
+    response = httpx.post(url=ocm_url + "/account/list", headers={"authorization": token})
+    if response.status_code != 200:
+        raise Exception(f"Failed to get accounts {response}.")
+    accounts = {
+        account["account"]["accountName"]: account["account"]["accountId"]
+        for account in response.json()
+    }
+    return accounts
+
+
+def get_default_hpc(token: str, account_id: str):
+    """Get the default HPC ID."""
+    ocm_url = os.environ["OCM_URL"]
+    response = httpx.post(
+        url=ocm_url + "/account/hpc/default",
+        json={"accountId": account_id},
+        headers={"authorization": token},
+    )
+    if response.status_code != 200:
+        raise Exception(f"Failed to get accounts {response}.")
+    return response.json()["hpcId"]
+
+
+def create_submit_job(
+    client,
+    concept: dict,
+    account_id: str,
+    hpc_id: str,
+    job_name: str = "cli_job: " + datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
+):
+    """Create and then submit a job."""
+    job_input = {
+        "job_name": job_name,
+        "requirement_ids": concept["requirements_ids"],
+        "architecture_id": concept["architecture_id"],
+        "concept_id": concept["id"],
+        "design_instance_id": concept["design_instance_id"],
+    }
+    job, uploaded_file = post(client, "/jobs", data=job_input)
+    job_start = {
+        "job": job,
+        "uploaded_file": uploaded_file,
+        "account_id": account_id,
+        "hpc_id": hpc_id,
+    }
+    job_info = post(client, "/jobs:start", data=job_start)
+    return job_info
+
+
+def read_file(filename: str) -> str:
+    """Read a given file."""
+    with open(filename) as f:
+        content = f.read()
+    return content
+
+
+def read_results(
+    client,
+    job_info: dict,
+    calculate_units: bool = True,
+    no_of_tries: int = 200,
+    rate_limit: float = 0.3,
+) -> dict:
+    """Read job results.
+
+    Continuously request job results until a valid response is received or a limit of tries is
+    reached.
+    """
+    version_number = get(client, "/utilities:data_format_version")
+    for _ in range(0, no_of_tries):
+        response = client.post(
+            url="/jobs:result",
+            json=job_info,
+            params={
+                "results_file_name": f"output_file_v{version_number}.json",
+                "calculate_units": calculate_units,
+            },
+        )
+        time.sleep(rate_limit)
+        if response.status_code == 200:
+            return response.json()
+
+    raise Exception(f"There are too many requests: {response}.")
+
+
+def post_component_file(client: httpx.Client, filename: str, component_file_type: str) -> dict:
+    """Send a POST request to the base client with a file.
+
+    An HTTP verb that performs the ``POST`` request, adds the route to the base client,
+    and then adds the file as a multipart form request.
+    """
+    path = "/components:upload"
+    file_contents = read_file(filename)
+    response = client.post(
+        url=path, files={"file": file_contents}, params={"component_file_type": component_file_type}
+    )
+    return process_response(response)
+
+
+if __name__ == "__main__":
+    token = get_token()
+
+    with get_http_client(token) as client:  # Create a client to talk to the API
+        health = get(client, "/health")  # Check that the API is healthy
+        print(health)
+        concepts = get(client, "/concepts")  # Get a list of concepts
+        print(concepts)