Skip to content

feat: adding PySherlock #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 21, 2023
Merged

feat: adding PySherlock #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e5cabf
feat: adding PySherlock
RobPasMue Jun 20, 2023
9d584f5
fix: solving errors
RobPasMue Jun 20, 2023
83d10dd
feat: adding custom image
RobPasMue Jun 21, 2023
86ff442
Merge branch 'main' into feat/pysherlock
RobPasMue Jun 21, 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
1 change: 1 addition & 0 deletions .github/workflows/create-milestone.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ jobs:
"ansys/grantami-recordlist",
"ansys/openapi-common",
"ansys/pyseascape",
"ansys/pysherlock",
"ansys/pyprimemesh",
"ansys/pytwin",
"ansys/pysystem-coupling",
Expand Down
2 changes: 2 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
- `PyPIM <https://pypim.docs.pyansys.com/>`_: Pythonic interface to communicate with the Ansys PIM (Product Instance Management) API.
- `PyPrimeMesh <https://prime.docs.pyansys.com>`_: Pythonic interface to Ansys Prime Server, which delivers core Ansys meshing technology.
- `PySeascape <https://seascape.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys RedHawkSC and TotemSC.
- `PySherlock <https://sherlock.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys Sherlock.
- `PySystemCoupling <https://systemcoupling.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys System Coupling.
- `PyTwin <https://twin.docs.pyansys.com/>`_: Pythonic interface to communicate with consumption workflows for Ansys digital twins.
- `Granta MI BoM Analytics <https://bomanalytics.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI BoM Analytics services.
Expand All @@ -78,6 +79,7 @@ By default, the PyAnsys metapackage installs these core modules:
- `PyPIM`_
- `PyPrimeMesh`_
- `PySeascape`_
- `PySherlock`_
- `PySystemCoupling`_
- `PyTwin`_
- `Granta MI BoM Analytics`_
Expand Down
Binary file added doc/source/_static/thumbnails/pysherlock.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ PyAnsys packages API reference
:text-align: center
:class-title: pyansys-card-title

.. grid-item-card:: PySherlock
:img-top: _static/thumbnails/pysherlock.png
:link: https://sherlock.docs.pyansys.com/version/stable/api/index.html
:text-align: center
:class-title: pyansys-card-title

.. grid-item-card:: PySystemCoupling
:img-top: _static/thumbnails/pysystem-coupling.png
:link: https://systemcoupling.docs.pyansys.com/version/stable/api/index.html
Expand Down
6 changes: 6 additions & 0 deletions doc/source/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ PyAnsys packages examples
:text-align: center
:class-title: pyansys-card-title

.. grid-item-card:: PySherlock
:img-top: _static/thumbnails/pysherlock.png
:link: https://sherlock.docs.pyansys.com/version/stable/getting_started/index.html
:text-align: center
:class-title: pyansys-card-title

.. grid-item-card:: PySystemCoupling
:img-top: _static/thumbnails/pysystem-coupling.png
:link: https://systemcoupling.docs.pyansys.com/version/stable/examples/index.html
Expand Down
8 changes: 8 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,14 @@ it is now a collection of many Python packages for using Ansys products through

Pythonic interface to communicate with Ansys RedHawkSC and TotemSC

.. grid-item-card:: PySherlock
:img-top: _static/thumbnails/pysherlock.png
:link: https://sherlock.docs.pyansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title

Pythonic interface to communicate with Ansys Sherlock

.. grid-item-card:: PySystem Coupling
:img-top: _static/thumbnails/pysystem-coupling.png
:link: https://systemcoupling.docs.pyansys.com/version/stable
Expand Down
6 changes: 6 additions & 0 deletions doc/source/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@ PyAnsys packages user guides
:text-align: center
:class-title: pyansys-card-title

.. grid-item-card:: PySherlock
:img-top: _static/thumbnails/pysherlock.png
:link: https://sherlock.docs.pyansys.com/version/stable/user_guide/index.html
:text-align: center
:class-title: pyansys-card-title

.. grid-item-card:: PySystemCoupling
:img-top: _static/thumbnails/pysystem-coupling.png
:link: https://systemcoupling.docs.pyansys.com/version/stable/users_guide/index.html
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ dependencies = [
"ansys-grantami-recordlists==1.0.0.post1",
"ansys-openapi-common==1.2.1",
"ansys-seascape==0.2.0",
"ansys-sherlock-core==0.2.0",
"ansys-meshing-prime==0.3.2",
"pytwin==0.3.0",
"ansys-systemcoupling-core==0.1.3",
Expand Down