Skip to content

Improve backwards compatibility documentation #175

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.

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Andy-Grigg
Copy link
Collaborator

Closes #174

Improve the documentation to describe the backwards compatibility of PyGranta packages.

Also includes a refresh of the Getting Started guide

Most packages require access to an installation of Ansys Granta MI. For more
information on getting a licensed copy of Ansys products, visit the `Ansys website <https://www.ansys.com/>`_.
.. note::
The ``ansys-grantami-bomanalytics`` and ``ansys-grantami-bomanalytics-openapi`` versions included in the metapackage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure exactly how I would phrase this, it's a tricky one, but perhaps something like "The ansys-grantami-bomanalytics and ansys-grantami-bomanalytics-openapi versions included in the metapackage are compatible with the corresponding version of BoM Analytics Services, included with Granta MI Restricted Substances and Sustainability Reports.

This is normally the latest version available at the time of the metapackage release, however multiple versions of BoM Analytics Services are compatible with a single version of Granta MI."

This is probably the fiddliest section

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've re-worked this section slightly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And I have added a link to the corresponding part of the RS installation guide

@Andy-Grigg Andy-Grigg force-pushed the doc/backwards-compatibility branch from 1d54d2d to fb6952f Compare May 9, 2025 14:45
@Andy-Grigg Andy-Grigg requested a review from da1910 May 9, 2025 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation around Granta MI version support
2 participants