MAINT: technical review (#144)

Co-authored-by: wenhuiuy <[email protected]>
Co-authored-by: Revathy Venugopal <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Revathyvenugopal162 <[email protected]>

.flake8

@@ -3,5 +3,5 @@ exclude = venv, __init__.py, doc/build
 select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
 count = True
 max-complexity = 10
-max-line-length = 100
-statistics = True
+max-line-length = 120
+statistics = True

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# These owners will be the default owners for everything in the repo. Unless a
+# later match takes precedence, the PyDyna team will be requested for review when
+# someone opens a pull request.
+*       @ansys/pydyna

.github/labeler.yml

@@ -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/*

.github/workflows/ci_cd.yml

@@ -126,7 +126,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
     steps:
       - uses: ansys/actions/build-wheelhouse@v4
         with:

.gitignore

@@ -1,76 +1,166 @@
-# This is an example .gitignore and may need to be adapted per
-# project.
-
-# Compiled source #
-###################
-*.pyc
-*.pyd
-*.c
-*.cpp
-*.so
-*.o
-*.cache
-.pytest_cache/
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
 
-# OS generated files #
-######################
-.fuse_hidden*
-*~
-*swp
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
-# emacs
-flycheck*
-
-# Old files #
-_old/
+# C extensions
+*.so
 
-# Pip generated folders #
-#########################
-*.egg-info/
+# Distribution / packaging
+.Python
 build/
+develop-eggs/
 dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
 
-# autogenerated docs
-_autosummary
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
 
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
 
-# Testing
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
 .cov
 .coverage
-*,cover
-test-output.xml
-
-\#*
-.\#*
-/.ipynb_checkpoints
-
-/ansys/dyna/pre/Server/input/
-/ansys/dyna/pre/Server/output/
-/client.log
-/examples/pre/client.log
-/ansys/dyna/pre/Server/output/
-/ansys/dyna/pre/doc/build
-/doc/_build
-/doc/source/examples
-/examples/Airbag/client.log
-/examples/EM/client.log
-/examples/Explicit/client.log
-/examples/ICFD/client.log
-/examples/IGA/client.log
-/examples/Implicit/client.log
-/examples/SALE/client.log
-
-# Environment
-.env
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env/
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
 
-# VSCode
-.vscode/
-client.log
-/src/ansys/dyna/core/pre/Server/input
-/src/ansys/dyna/core/pre/Server/output
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Visual Studio
+.vs/
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+
+# Ignore rendered examples
+doc/source/examples/
+doc/source/API/_autosummary/

.pre-commit-config.yaml

@@ -15,37 +15,31 @@ exclude: |
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.1.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 23.3.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
-    args:
-      - --line-length=120 
 
 - repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.13.0
+  rev: 1.14.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.1.0]
+    additional_dependencies: [black==23.3.0]
 
-- repo: https://github.com/codespell-project/codespell
-  rev: v2.2.2
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
   hooks:
-  - id: codespell
-    args: ["--ignore-words=ignore_words.txt"]
+  - id: isort
 
 - repo: https://github.com/PyCQA/flake8
   rev: 6.0.0
   hooks:
   - id: flake8
-    args:
-      - --max-line-length=120
 
-- repo: https://github.com/pycqa/isort
-  rev: 5.12.0
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.5
   hooks:
-  - id: isort
-    args:
-      - --line-length=120
+  - id: codespell
+    args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0
@@ -55,6 +49,6 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.21.0
+  rev: 0.23.2
   hooks:
-    - id: check-github-workflows
+    - id: check-github-workflows

AUTHORS.md

@@ -0,0 +1,7 @@
+# Authors
+
+## Contributors
+
+* [Zhanqun Zhang](https://github.com/zhangzhanqun)
+* [Wenhui Yu](https://github.com/wenhuiuy)
+* [Srikanth Adya](https://github.com/kanthadya)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 ANSYS, Inc. All rights reserved. 
+Copyright (c) 2023 ANSYS, Inc. All rights reserved. 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal