.. image:: https://github.com/ansys/pystk/blob/main/doc/source/_static/logo.png
   :target: https://github.com/ansys/pystk/
   :alt: PySTK

|

|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |YouTube| |LinkedIn| |ruff|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&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/pypi/pyversions/ansys-stk?logo=python&logoColor=white&label=Python
   :target: https://pypi.org/project/ansys-stk/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-stk.svg?logo=pypi&logoColor=white&label=PyPI
   :target: https://pypi.org/project/ansys-stk/
   :alt: PyPI

.. |codecov| image:: https://img.shields.io/codecov/c/github/ansys/pystk
   :target: https://app.codecov.io/gh/ansys/pystk
   :alt: Codecov

.. |GH-CI| image:: https://github.com/ansys/pystk/actions/workflows/ci_cd_night.yml/badge.svg?label=CI
   :target: https://github.com/ansys/pystk/actions/workflows/ci_cd_night.yml
   :alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-white.svg?labelColor=black
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

.. |LinkedIn| image:: https://img.shields.io/badge/LinkedIn-blue.svg?logo=linkedin&logoColor=white
   :target: https://www.linkedin.com/showcase/ansys-digital-mission-engineering
   :alt: LinkedIn

.. |YouTube| image:: https://img.shields.io/badge/YouTube-white.svg?labelColor=c3c3c3&logo=youtube&logoColor=red
   :target: https://www.youtube.com/user/AnalyticalGraphics
   :alt: YouTube

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff
   :alt: Ruff

About
=====

PySTK is a Python library that provides a powerful and user-friendly API for
`Systems Tool Kit`_ (STK). It is designed to enhance the interaction with STK by
offering a comprehensive set of tools and functionalities.

With PySTK library, developers can easily integrate STK into their Python
applications. It provides a streamlined and efficient way to automate scenarios,
create custom applications and integrate with other popular Python libraries.

Installation
============

Ensure you have all the necessary `prerequisites`_. Then, refer to the
`installation guidelines`_ for detailed instructions on how to install PySTK
in your system.

Documentation
=============

The `official documentation`_ of PySTK contains the following chapters:

- `Getting started`_. This section provides a brief overview and instructions on
  how to get started with the project. It typically includes information on how
  to install the project, set up any necessary dependencies, and run a basic
  example or test to ensure everything is functioning correctly.

- `User guide`_. The user guide section offers detailed documentation and
  instructions on how to use the project. It provides comprehensive explanations
  of the project's features, functionalities, and configuration options. The
  user guide aims to help users understand the project's concepts, best
  practices, and recommended workflows.

- `API reference`_. The API reference section provides detailed documentation
  for the project's application programming interface (API). It includes
  information about classes, functions, methods, and their parameters, return
  values, and usage examples. This reference helps developers understand the
  available API endpoints, their functionalities, and how to interact with them
  programmatically.

- `Examples`_. The examples section showcases practical code examples that
  demonstrate how to use the project in real-world scenarios. It provides sample
  code snippets or complete scripts that illustrate different use cases or
  demonstrate specific features of the project. Examples serve as practical
  references for developers, helping them understand how to apply the project to
  their own applications.

- `Contribute`_. This section provides guidelines and instructions on how to
  contribute to the project. It includes information on how to set up the
  development environment, run tests, submit pull requests, and follow
  contribution guidelines.

- `Artifacts`_. Contains the artifacts generated by the project, like wheels and
  source distribution files. Additional targets are available too.


Troubleshooting
===============

For troubleshooting or reporting issues, please open an issue in the project
repository.

Please follow these steps to report an issue:

- Go to the project repository.
- Click on the ``Issues`` tab.
- Click on the ``New Issue`` button.
- Provide a clear and detailed description of the issue you are facing.
- Include any relevant error messages, code snippets, or screenshots.

Additionally, you can refer to the `official documentation`_ for additional
resources and troubleshooting guides.

License
=======

You can find the full text of the license in the `LICENSE`_ file.

Changelog
=========

The changelog section provides a summary of notable changes for each version of
PySTK. It helps you keep track of updates, bug fixes, new features, and
improvements made to the project over time.

To view the complete changelog, please visit the project repository and navigate
to the `CHANGELOG`_ file. It provides a comprehensive list of changes
categorized by version, along with brief descriptions of each change.


.. Ansys products
.. _Systems Tool Kit: https://www.ansys.com/products/missions/ansys-stk

.. Prerequisites and installation guidelines
.. _prerequisites: https://stk.docs.pyansys.com/version/dev/getting-started/prerequisites.html
.. _contribute: https://stk.docs.pyansys.com/version/dev/contribute.html
.. _installation guidelines: https://stk.docs.pyansys.com/version/dev/getting-started/install.html

.. Documentation chapters
.. _official documentation: https://stk.docs.pyansys.com
.. _getting started: https://stk.docs.pyansys.com/version/dev/getting-started.html
.. _user guide: https://stk.docs.pyansys.com/version/dev/user-guide.html
.. _api reference: https://stk.docs.pyansys.com/version/dev/api.html
.. _examples: https://stk.docs.pyansys.com/version/dev/examples.html
.. _contribute: https://stk.docs.pyansys.com/version/dev/contribute.html
.. _artifacts: https://stk.docs.pyansys.com/version/dev/artifacts.html

.. _LICENSE: https://github.com/ansys/pystk/blob/main/LICENSE
.. _CHANGELOG: https://github.com/ansys/pystk/blob/main/CHANGELOG.md
