Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 4 additions & 5 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ documentation:
maintenance:
- .github/**/*
- .flake8
- setup.py
- pyproject.toml
dependencies:
- requirements/**/*
- requirements_docs.txt
- requirements_test.txt
- pyproject.toml
testing:
- _unittest/conftest.py
- _unittest/conftest.py
- tests/*
72 changes: 70 additions & 2 deletions doc/source/Resources/Contributing.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,76 @@
Contributing
-------------
============

Overall guidance on contributing to a PyAnsys repository appears in the
`Contributing <https://dev.docs.pyansys.com/overview/contributing.html>`_ topic
in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
with it and all `Guidelines and Best Practices <https://dev.docs.pyansys.com/guidelines/index.html>`_
before attempting to contribute to PyDyna.
before attempting to contribute to PyDyna.

The following contribution information is specific to PyDyna.

Clone the repository
--------------------
Copy link
Member

Choose a reason for hiding this comment

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

I am leaving this comment here but it applies to the header in line 2 of this file.

Headers in our chapter must start with the # symbol while sections in chapters use =.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jorgepiloto Thanks for pointing that. fixed at a4dbe0e


To clone and install the latest PyDyna release in development mode, run:

.. code::

git clone https://github.com/pyansys/PyDyna
cd PyDyna
python -m pip install --upgrade pip
pip install -e .


Post issues
-----------

Use the `PyDyna Issues <https://github.com/pyansys/PyDyna/issues>`_
page to submit questions, report bugs, and request new features. When possible, you
should use these issue templates:

* Bug report template
* Feature request template

If your issue does not fit into these categories, create your own issue.

To reach the PyAnsys team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.

View documentation
------------------

Documentation for the latest stable release of PyDyna is hosted at
`PyDyna Documentation <https://dyna.docs.pyansys.com>`_.

Documentation for the latest development version, which tracks the
``main`` branch, is hosted at `Development PyDyna Documentation <https://dyna.docs.pyansys.com/dev/>`_.
This version is automatically kept up to date via GitHub actions.

Code style
----------

PyDyna follows the PEP8 standard as outlined in the `PyAnsys Development Guide
<https://dev.docs.pyansys.com>`_ and implements style checking using
`pre-commit <https://pre-commit.com/>`_.

To ensure your code meets minimum code styling standards, run::

pip install pre-commit
pre-commit run --all-files

You can also install this as a pre-commit hook by running::

pre-commit install

This way, it's not possible for you to push code that fails the style checks. For example::

$ pre-commit install
$ git commit -am "added my cool feature"
black....................................................................Passed
blacken-docs.............................................................Passed
codespell................................................................Passed
flake8...................................................................Passed
isort....................................................................Passed
check for merge conflicts................................................Passed
debug statements (python)................................................Passed
Validate GitHub Workflows................................................Passed
4 changes: 2 additions & 2 deletions doc/source/Resources/Getting_Started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Installation
~~~~~~~~~~~~

This package is not yet available on the public PyPI, but you can still install
it using ``pip`` from our private PyPI repository.
it using ``pip`` from the private PyPI repository.

The following on Windows:

Expand All @@ -24,7 +24,7 @@ And if you are running Linux:
python -m pip install ansys-dyna-core --index-url $INDEX_URL

Email your friendly PyAnsys team member for the ``PYANSYS_PYPI_PRIVATE_PAT``
at `pyansys.core@ansys.com <mailto:pyansys.core@ansys.com>`_ or send us a message via Teams.
at `pyansys.core@ansys.com <mailto:pyansys.core@ansys.com>`_ or send a message via Teams.

**Installing from git**

Expand Down
2 changes: 2 additions & 0 deletions doc/source/Resources/pydyna_post.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- vale off -->
Using PyDPF-post for LS-DYNA
============================
<!-- vale on -->

Operators
~~~~~~~~~
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ tests = [
"numpy==1.24.2",
"pytest==7.3.0",
"pytest-cov==4.0.0",
"codecov==2.1.12",
"joblib==1.2.0",
"pandas==2.0.0",
"openpyxl==3.1.2",
Expand Down
Loading