Skip to content

Commit d84345f

Browse files
pyansys-automationiboyd-ansys
authored andcommitted
Bump version 0.11.2
1 parent 1f40328 commit d84345f

File tree

7 files changed

+99
-54
lines changed

7 files changed

+99
-54
lines changed

CODE_OF_CONDUCT.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributor covenant code of conduct
2+
3+
## Pledge
4+
5+
In the interest of fostering an open and welcoming environment,
6+
all contributors and maintainers pledge to making participation
7+
in the Ansys project and community a harassment-free experience
8+
for everyone, regardless of age, body size, disability, ethnicity,
9+
sex characteristics, gender identity and expression, level of
10+
experience, education, socioeconomic status, nationality, personal
11+
appearance, race, religion, or sexual identity and orientation.
12+
13+
## Standards
14+
15+
Examples of behavior that contribute to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual
27+
attention or advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44+
contributor for other behaviors that they deem inappropriate, threatening,
45+
offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project email
52+
address, posting using an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
## Attribution
57+
58+
This code of conduct is adapted from the [Contributor Covenant][homepage],
59+
version 1.4, available at
60+
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
61+
62+
[homepage]: https://www.contributor-covenant.org
63+
64+
For answers to common questions about this code of conduct, see
65+
<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# Contributing
2-
3-
We absolutely welcome any code contributions and we hope that this
4-
guide will facilitate an understanding of the PySystemCoupling code
5-
repository. It is important to note that while the PySystemCoupling software
6-
package is maintained by ANSYS and any submissions will be reviewed
7-
thoroughly before merging, we still seek to foster a community that can
8-
support user questions and develop new features to make this software
9-
a useful tool for all users. As such, we welcome and encourage any
10-
questions or submissions to this repository.
11-
12-
For contributing to this project, please refer to the [PyAnsys Developer's
13-
Guide](https://dev.docs.pyansys.com/). Further information about
14-
contributing to PySystemCoupling can be found in
15-
[Contributing](https://systemcoupling.docs.pyansys.com/dev/contributing.html).
1+
# Contribute
2+
3+
Overall guidance on contributing to a PyAnsys library appears in the
4+
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
5+
are thoroughly familiar with this guide before attempting to contribute to
6+
PySystemCoupling.
7+
8+
The following contribution information is specific to {project-name}.
9+
10+
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
11+
12+
See the [Contribute] section for the project.
13+
14+
[Contribute]: https://systemcoupling.docs.pyansys.com/version/dev/contributing.html

README.rst

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,22 +83,28 @@ In a standard user installation, the expectation is that only ``AWP_ROOT252`` is
8383
(It is also possible to provide a different version number as an argument to the ``launch()``
8484
function. This will affect which ``AWP_ROOT<version>`` environment variable is examined.)
8585

86-
**WARNING**
86+
**NOTE**
8787

88-
Note that the following applies only to the 25 R1 release of Ansys System Coupling.
88+
Releases of 0.11.0 and later of PySystemCoupling define the ``launch()`` function so that
89+
its *default* behavior is consistent with service pack releases of Ansys as follows:
8990

90-
There is an issue with the 25 R1 release of Ansys System Coupling that prevents it from
91-
working in the gRPC server mode on which PySystemCoupling depends. A small patch
92-
is available that may be applied to some of the Python files in the System Coupling
93-
installation. This is provided in the ``patches/`` directory of this repository and will
94-
allow System Coupling 25 R1 to work with PySystemCoupling releases 0.9 and later.
91+
* **24 R2** - Service Pack 5 and later
92+
* **25 R1** - Service Pack 4 and later
93+
* **25 R2** - Service Pack 3 and later
9594

96-
This issue is not present in later releases of System Coupling. If a later release
97-
is available, you are recommended to use that.
95+
You can still use earlier releases and service packs of Ansys System Coupling, but
96+
to do so you must specify a new ``connection_type`` argument to the ``launch()``
97+
function with value ``ConnectionType.LOCAL_INSECURE``. See the API documentation
98+
for more information.
9899

99-
Alternatively, PySystemCoupling can be used with an earlier release of System Coupling by
100-
setting the environment variable ``AWP_ROOT`` or specifying the version number as an
101-
argument to the ``launch()`` function.
100+
Note that the following applies only to the **25 R1** release of Ansys System Coupling.
101+
102+
There was an issue with 25 R1, earlier than the Service Pack 3 release,
103+
that prevented it from working in the gRPC server mode on which PySystemCoupling
104+
depends. A small patch was made available in this repository to address this issue.
105+
As this issue has now been officially fixed in the Service Pack 3 release of 25 R1,
106+
the patch has been removed and you are recommended to install Service Pack 3 of
107+
25 R1 or the latest service pack of a later release.
102108

103109

104110
The System Coupling API is exposed to PySystemCoupling in two forms:

patches/README.txt

Lines changed: 0 additions & 25 deletions
This file was deleted.
-19.2 KB
Binary file not shown.
-16.9 KB
Binary file not shown.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
55
[project]
66
# Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
77
name = "ansys-systemcoupling-core"
8-
version = "0.11.1"
8+
version = "0.11.2"
99
description = "A Python wrapper for Ansys System Coupling."
1010
readme = "README.rst"
1111
requires-python = ">=3.10,<3.14"
@@ -64,7 +64,7 @@ doc = [
6464
"numpydoc==1.9.0",
6565
"pypandoc==1.16.2",
6666
"pytest-sphinx==0.6.3",
67-
"sphinx>=8.1.3",
67+
"sphinx>=8.1.3,<9.0.0",
6868
"sphinx-autobuild==2024.10.3",
6969
"sphinx-autodoc-typehints==3.1.0",
7070
"sphinx-copybutton==0.5.2",

0 commit comments

Comments
 (0)