Rename package to ansys-additive-core (#63)

Author: pkrull-ansys

.github/workflows/ci_cd.yml

@@ -12,7 +12,7 @@ on:
 env:
   MAIN_PYTHON_VERSION: "3.10"
   DOCUMENTATION_CNAME: "additive.docs.pyansys.com"
-  LIBRARY_NAME: "ansys-additive"
+  LIBRARY_NAME: "ansys-additive-core"
   ANSYS_PRODUCT_IMAGE: "ghcr.io/ansys/additive:latest"
   ANSYS_PRODUCT_CONTAINER: "ansys-additive-container"
 

README.rst

@@ -12,15 +12,15 @@ PyAdditive
    :target: https://docs.pyansys.com/
    :alt: PyAnsys
 
-.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-additive?logo=pypi
-   :target: https://pypi.org/project/ansys-additive/
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-additive-core?logo=pypi
+   :target: https://pypi.org/project/ansys-additive-core/
    :alt: Python
 
-.. |pypi| image:: https://img.shields.io/pypi/v/ansys-additive.svg?logo=python&logoColor=white
-   :target: https://pypi.org/project/ansys-additive
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-additive-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-additive-core
    :alt: PyPI
 
-.. |codecov| image:: https://codecov.io/gh/pyansys/ansys-additive/branch/main/graph/badge.svg
+.. |codecov| image:: https://codecov.io/gh/pyansys/ansys-additive-core/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/pyansys/pyadditive
    :alt: Codecov
 
@@ -46,7 +46,7 @@ a private PyPI repository must be used. See `Getting Started`_ for more informat
 
 .. code:: bash
 
-    pip install ansys-additive --index-url=https://${PYANSYS_PYPI_PRIVATE_PAT}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
+    pip install ansys-additive-core --index-url=https://${PYANSYS_PYPI_PRIVATE_PAT}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
 
 To install the latest development version, use the following commands.
 
@@ -61,7 +61,7 @@ Basic Usage
 
 .. code:: python
 
-   import ansys.additive as pyadditive
+   import ansys.additive.core as pyadditive
 
    additive = pyadditive.Additive()
 

doc/source/conf.py

@@ -9,7 +9,7 @@
 import pyvista
 from sphinx_gallery.sorting import FileNameSortKey
 
-from ansys.additive import __version__
+from ansys.additive.core import __version__
 
 # Manage errors
 pyvista.set_error_output_file("errors.txt")
@@ -243,7 +243,7 @@
         # directory where function granular galleries are stored
         "backreferences_dir": None,
         # Modules for which function level galleries are created.
-        "doc_module": "ansys-additive",
+        "doc_module": "ansys-additive-core",
         "image_scrapers": ("pyvista", "matplotlib"),
         "ignore_pattern": r"\b(" + "|".join(map(re.escape, ignore_patterns)) + r")\b",
         "thumbnail_size": (350, 350),
@@ -259,7 +259,7 @@
 }
 
 linkcheck_ignore = [
-    r"https://pypi.org/project/ansys-additive.*",  # TODO: remove once pyadditive is published
+    r"https://pypi.org/project/ansys-additive-core.*",  # TODO: remove once pyadditive is published
     r"https://github.com/ansys-internal/.*",  # TODO: remove once pyadditive is published
     r"https://ansyshelp.ansys.com/.*",
     r"https://ansysproducthelpqa.win.ansys.com/.*",

doc/source/getting_started/index.rst

@@ -40,7 +40,7 @@ Once logged in to Ansys Lab, create a new jupyter notebook and connect to the ad
 
 .. code:: pycon
 
-   >>> import ansys.additive as pyadditive
+   >>> import ansys.additive.core as pyadditive
    >>> additive = pyadditive.Additive()
 
 Example notebooks can found in the `Examples <https://additive.docs.pyansys.com/dev/examples/index.html>`_
@@ -67,7 +67,7 @@ Next, connect to the service with:
 
 .. code:: pycon
 
-   >>> import ansys.additive as pyadditive
+   >>> import ansys.additive.core as pyadditive
    >>> additive = pyadditive.Additive()
 
 Installation
@@ -109,7 +109,7 @@ Then, you can simply execute:
 
 .. code:: bash
 
-   python -m pip install ansys-additive
+   python -m pip install ansys-additive-core
 
 .. warning::
 
@@ -121,10 +121,10 @@ Then, you can simply execute:
     .. code:: bash
 
         # On linux
-        pip install ansys-additive --index-url=https://${PYANSYS_PYPI_PRIVATE_PAT}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
+        pip install ansys-additive-core --index-url=https://${PYANSYS_PYPI_PRIVATE_PAT}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
 
         # On Windows
-        pip install ansys-additive --index-url=https://%PYANSYS_PYPI_PRIVATE_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
+        pip install ansys-additive-core --index-url=https://%PYANSYS_PYPI_PRIVATE_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
 
     See preceding note for how to get the access token to use for ``PYANSYS_PYPI_PRIVATE_PAT``.
 
@@ -200,8 +200,8 @@ For example, on Linux with Python 3.8, unzip the wheelhouse archive and install
 
 .. code:: bash
 
-    unzip ansys-additive-v0.1.dev0-wheelhouse-Linux-3.8.zip wheelhouse
-    pip install ansys-additive -f wheelhouse --no-index --upgrade --ignore-installed
+    unzip ansys-additive-core-v0.1.dev0-wheelhouse-Linux-3.8.zip wheelhouse
+    pip install ansys-additive-core -f wheelhouse --no-index --upgrade --ignore-installed
 
 If you're on Windows with Python 3.9, unzip to a wheelhouse directory and install using the preceding command.
 

examples/00_additive_single_bead.py

@@ -13,8 +13,8 @@
 """
 import matplotlib.pyplot as plt
 
-import ansys.additive as pyadditive
-from ansys.additive import MeltPoolColumnNames
+import ansys.additive.core as pyadditive
+from ansys.additive.core import MeltPoolColumnNames
 
 additive = pyadditive.Additive()
 
@@ -23,22 +23,22 @@
 # ---------------
 # The next step is a to choose a material. A list of available materials can
 # be obtained using the
-# :meth:`get_materials_list() <ansys.additive.additive.Additive.get_materials_list>`
+# :meth:`get_materials_list() <ansys.additive.core.additive.Additive.get_materials_list>`
 # command.
 
 print(additive.get_materials_list())
 
 ###############################################################################
 # Obtain the parameters for a single material by passing one of the names
 # from the materials list to
-# :meth:`get_material() <ansys.additive.additive.Additive.get_material>`.
+# :meth:`get_material() <ansys.additive.core.additive.Additive.get_material>`.
 material = additive.get_material("17-4PH")
 
 ###############################################################################
 # Set Machine Parameters
 # ----------------------
 # Specify machine parameters by first creating an
-# :class:`AdditiveMachine <ansys.additive.machine.AdditiveMachine>` object
+# :class:`AdditiveMachine <from ansys.additive.core.machine.AdditiveMachine>` object
 # then assigning the desired values. All values are in SI units (m, kg, s, K)
 # unless otherwise noted.
 
@@ -55,7 +55,7 @@
 ###############################################################################
 # Specify Single Bead Simulation Inputs
 # -------------------------------------
-# Create a :class:`SingleBeadInput <ansys.additive.single_bead.SingleBeadInput>`
+# Create a :class:`SingleBeadInput <ansys.additive.core.single_bead.SingleBeadInput>`
 # object containing the desired simulation parameters.
 
 input = pyadditive.SingleBeadInput(
@@ -65,11 +65,11 @@
 ###############################################################################
 # Run Simulation
 # --------------
-# Use the :meth:`simulate() <ansys.additive.additive.Additive.simulate>`
+# Use the :meth:`simulate() <ansys.additive.core.additive.Additive.simulate>`
 # method of the ``additive`` object to run the simulation. The returned object is a
-# :class:`SingleBeadSummary <ansys.additive.single_bead.SingleBeadSummary>`
+# :class:`SingleBeadSummary <ansys.additive.core.single_bead.SingleBeadSummary>`
 # containing the input and a
-# :class:`MeltPool <ansys.additive.single_bead.MeltPool>` object.
+# :class:`MeltPool <ansys.additive.core.single_bead.MeltPool>` object.
 
 summary = additive.simulate(input)
 
@@ -78,7 +78,7 @@
 # -------------------------
 # A :class:`Pandas DataFrame <pandas.DataFrame>` containing the melt pool
 # statistics can be obtained using the
-# :meth:`data_frame() <ansys.additive.single_bead.MeltPool.data_frame>` property
+# :meth:`data_frame() <ansys.additive.core.single_bead.MeltPool.data_frame>` property
 # of the ``melt_pool`` attribute of the ``summary`` object. The
 # :meth:`plot() <pandas.DataFrame.plot>` method can be used to plot the melt
 # pool dimensions as a function of bead length.

examples/01_additive_porosity.py

@@ -10,7 +10,7 @@
 
 First, connect to the Additive service.
 """
-import ansys.additive as pyadditive
+import ansys.additive.core as pyadditive
 
 additive = pyadditive.Additive()
 
@@ -19,22 +19,22 @@
 # ---------------
 # The next step is a to choose a material. A list of available materials can
 # be obtained using the
-# :meth:`get_materials_list() <ansys.additive.additive.Additive.get_materials_list>`
+# :meth:`get_materials_list() <ansys.additive.core.additive.Additive.get_materials_list>`
 # command.
 
 print(additive.get_materials_list())
 
 ###############################################################################
 # Obtain the parameters for a single material by passing one of the names
 # from the materials list to
-# :meth:`get_material() <ansys.additive.additive.Additive.get_material>`.
+# :meth:`get_material() <ansys.additive.core.additive.Additive.get_material>`.
 material = additive.get_material("316L")
 
 ###############################################################################
 # Set Machine Parameters
 # ----------------------
 # Specify machine parameters by first creating an
-# :class:`AdditiveMachine <ansys.additive.machine.AdditiveMachine>` object
+# :class:`AdditiveMachine <from ansys.additive.core.machine.AdditiveMachine>` object
 # then assigning the desired values. All values are in SI units (m, kg, s, K)
 # unless otherwise noted.
 machine = pyadditive.AdditiveMachine()
@@ -50,7 +50,7 @@
 ###############################################################################
 # Specify Porosity Simulation Inputs
 # ----------------------------------
-# Create a :class:`PorosityInput <ansys.additive.porosity.PorosityInput>` object
+# Create a :class:`PorosityInput <ansys.additive.core.porosity.PorosityInput>` object
 # containing the desired simulation parameters.
 
 input = pyadditive.PorosityInput(
@@ -65,9 +65,9 @@
 ###############################################################################
 # Run Simulation
 # --------------
-# Use the :meth:`simulate() <ansys.additive.additive.Additive.simulate>` method
+# Use the :meth:`simulate() <ansys.additive.core.additive.Additive.simulate>` method
 # on the ``additive`` object to run the simulation. The returned object is a
-# :class:`PorositySummary <ansys.additive.porosity.PorositySummary>` object
+# :class:`PorositySummary <ansys.additive.core.porosity.PorositySummary>` object
 # containing the input and the relative density of the simulated sample.
 
 summary = additive.simulate(input)

examples/02_additive_microstructure.py

@@ -11,7 +11,7 @@
 
 First, connect to the Additive service.
 """
-import ansys.additive as pyadditive
+import ansys.additive.core as pyadditive
 
 additive = pyadditive.Additive()
 
@@ -20,15 +20,15 @@
 # ---------------
 # The next step is a to choose a material. A list of available materials can
 # be obtained using the
-# :meth:`get_materials_list() <ansys.additive.additive.Additive.get_materials_list>`
+# :meth:`get_materials_list() <ansys.additive.core.additive.Additive.get_materials_list>`
 # command.
 
 print(additive.get_materials_list())
 
 ###############################################################################
 # Obtain the parameters for a single material by passing one of the names
 # from the materials list to
-# :meth:`get_material() <ansys.additive.additive.Additive.get_material>`.
+# :meth:`get_material() <ansys.additive.core.additive.Additive.get_material>`.
 material = additive.get_material("17-4PH")
 
 ###############################################################################
@@ -108,7 +108,7 @@
 import pandas as pd
 import pyvista as pv
 
-from ansys.additive import CircleEquivalenceColumnNames
+from ansys.additive.core import CircleEquivalenceColumnNames
 
 ###############################################################################
 # Plot Grain 2D Visualizations

examples/03_additive_thermal_history.py

@@ -11,7 +11,7 @@
 
 First, connect to the Additive service.
 """
-import ansys.additive as pyadditive
+import ansys.additive.core as pyadditive
 
 additive = pyadditive.Additive()
 
@@ -27,7 +27,7 @@
 # Example build and STL files can be downloaded by importing the examples
 # module as shown below.
 
-import ansys.additive.examples as examples
+import ansys.additive.core.examples as examples
 
 # Creating an ``StlFile`` object
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

examples/04_additive_doe.py

@@ -15,7 +15,7 @@
 # import matplotlib.pyplot as plt
 # import numpy as np
 
-# import ansys.additive as pyadditive
+# import ansys.additive.core as pyadditive
 
 # additive = pyadditive.Additive()
 

examples/05_advanced_optimization_workflow.py

@@ -17,7 +17,7 @@
 # import numpy as np
 # import pyvista as pv
 
-# import ansys.additive as pyadditive
+# import ansys.additive.core as pyadditive
 
 # additive = pyadditive.Additive()