Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
244c1dd
Edits made on 8/31/23
PipKat Aug 31, 2023
3aa130d
Edits to PyAdditive files
PipKat Sep 1, 2023
f2188b3
Edits to PyAdditive files
PipKat Sep 1, 2023
208ca91
Merge branch 'main' into doc/overall_review
PipKat Sep 1, 2023
8869997
Minor edit
PipKat Sep 1, 2023
dd9a962
Fix the ONE error message string that I did edit.
PipKat Sep 1, 2023
dba2c03
Fix heading underlines
pkrull-ansys Sep 1, 2023
532af92
Merge branch 'doc/overall_review' of https://github.com/ansys-interna…
pkrull-ansys Sep 1, 2023
a068a34
Update vale vocabulary
pkrull-ansys Sep 1, 2023
45e8793
Fix typo
pkrull-ansys Sep 1, 2023
c52782b
Fix typo
pkrull-ansys Sep 1, 2023
006707c
Fix parameter explanation
pkrull-ansys Sep 1, 2023
92b38ca
Fix doc comments and typo
pkrull-ansys Sep 1, 2023
4504059
Fix typo
pkrull-ansys Sep 1, 2023
9a68023
Fix typo
pkrull-ansys Sep 1, 2023
0daf90c
Fix doc string and return type
pkrull-ansys Sep 1, 2023
5812b8a
Fix typo and truncated doc string
pkrull-ansys Sep 1, 2023
ffeb6f2
Fix doc string
pkrull-ansys Sep 1, 2023
c3e6093
Fix wording of doc string
pkrull-ansys Sep 1, 2023
4460d4f
Reword doc strings
pkrull-ansys Sep 1, 2023
4e43560
Update src/ansys/additive/microstructure.py
pkrull-ansys Sep 1, 2023
c156d83
Fix doc strings
pkrull-ansys Sep 1, 2023
33c9bff
Merge branch 'doc/overall_review' of https://github.com/ansys-interna…
pkrull-ansys Sep 1, 2023
8a3d5da
Fix pre-commit check
pkrull-ansys Sep 1, 2023
0c7b8b1
Merge branch 'main' into doc/overall_review
RobPasMue Sep 4, 2023
9bf7dd6
Merge branch 'main' into doc/overall_review
RobPasMue Sep 4, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,28 +37,30 @@ PyAdditive
:alt: Black


A Python client library for the Ansys Additive service.
PyAdditive is a Python client library for the Ansys Additive service.

Installation
============
PyAdditive can be installed using ``pip``. Until PyAdditive is made public,
a private PyPI repository must be used. See `Getting Started`_ for more information.
You can use `pip <https://pypi.org/project/pip/>`_ to install PyAdditive. Until PyAdditive
is made public, you must use a private PyPI repository. For more information, see `Getting Started`_.

.. code:: bash

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.
To install the latest development version, run these commands:

.. code:: bash

git clone https://github.com/ansys-internal/pyadditive
cd pyadditive
pip install -e .

Basic Usage
Basic usage
===========

This code shows how to import PyAdditive and use some basic capabilities:

.. code:: python

import ansys.additive.core as pyadditive
Expand All @@ -74,15 +76,25 @@ Basic Usage

summary = additive.simulate(input)

For more detailed usage information, see the `Examples`_ in the `PyAdditive Documentation`_.
For comprehensive usage information, see `Examples`_ in the `PyAdditive Documentation`_.

Documentation and issues
========================
Documentation for the latest stable release of PyMechanical is hosted at `PyAdditive 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.

Documentation
=============
On the `PyAdditive Issues <https://github.com/ansys-internal/pyadditive/issues>`_ page,
you can create issues to report bugs and request new features. On the `PyAdditive Discussions
<https://github.com/ansys-internal/pyadditive/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email `[email protected] <mailto:[email protected]>`_.

Refer to the `PyAdditive Documentation`_ for more information.

.. LINKS AND REFERENCES
.. _Getting Started: https://additive.docs.pyansys.com/version/stable/getting_started/index.html
.. _Examples: https://additive.docs.pyansys.com/version/stable/examples/index.html
.. _PyAdditive Documentation: https://additive.docs.pyansys.com/version/stable/index.html

.. _Examples: https://additive.docs.pyansys.com/version/dev/examples/gallery_examples/index.html
.. _PyAdditive documentation: https://additive.docs.pyansys.com/version/stable/index.html
Loading