Repository: JulianKarlBauer/mechkit (language: python)

Issue:
Think about adding test_requirements following continuum_mechanics



Discussion / hints:

Fix patch:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 766e5be..8363950 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,31 +1,34 @@
-# Contributing guide of mechkit
+# Contributing Guide of Mechkit
 
 Thank you for investing your time in contributing to this project!
-
 Please follow the [Code of Conduct](./CODE_OF_CONDUCT.md) to keep the community approachable and respectable.
+In this guide you will get an overview of the contribution workflow.
 
-In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
-
-## New contributor guide
+## New Contributor Guide
 
 To get an overview of the project, read the [README](README.md).
-Github offers the following some resources to help you get started with open source contributions:
+Github offers the following resources to help you get started with open source contributions:
 
 - [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
-- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
-- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
+- [Fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
+- [Contributing to projects](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)
 
 
-## Workflow: Issues / Problems / Bugs
+## Bugs / Issues
 
 We don't like bugs, and are therefore grateful for any possibility to fix them.
-Please report any problems by opening an issue.
+Please report any problems by [opening an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue).
 Screenshots as well as minimal working examples are highly appreciated, as they ease the understanding of the problem.
 
-## Workflow: Code Contributions
+## Workflow: Fork -> Modify -> Test -> Pull Request
 
 The main goal of the project is the reuse of research code to increase the reliability of research results and to accelerate and simplify further research.
-This objective implies the need for continuous extension and improvement. As a consequence, code contributions of any kind are welcome.
-
-Please fork the repository, extend the code, and submit a merge request to incorporate your changes into the project after review.
+This objective implies the need for continuous extension and improvement.
+As a consequence, code contributions of any kind are welcome.
+
+Please
+- **fork** the repository,
+- **modify** and extend the code in your personal fork,
+- run **tests**,
+- open a **pull request** to incorporate your changes into original the project after review.
 
diff --git a/docs/source/material.rst b/docs/source/material.rst
index 2197d59..cda1d5a 100644
--- a/docs/source/material.rst
+++ b/docs/source/material.rst
@@ -1,6 +1,18 @@
 material
 --------
 
++-----------------------+-----------------------------------+-----------------------+
+| Object                | Number of independent parameters  | Adjustable alignment  |
++=======================+===================================+=======================+
+| Isotropic             | 2                                 | no                    |
++-----------------------+-----------------------------------+-----------------------+
+| TransversalIsotropic  | 5                                 | yes                   |
++-----------------------+-----------------------------------+-----------------------+
+| Orthotropic           | 9                                 | no                    |
++-----------------------+-----------------------------------+-----------------------+
+
+--------------------------------------------------------
+
 .. autoclass:: mechkit.material.Isotropic
 .. autoclass:: mechkit.material.TransversalIsotropic
 .. autoclass:: mechkit.material.Orthotropic
diff --git a/docs/source/notation.rst b/docs/source/notation.rst
index 6a6f41c..6b4f571 100644
--- a/docs/source/notation.rst
+++ b/docs/source/notation.rst
@@ -1,6 +1,16 @@
 notation
 --------
 
++-------------------------------------+-----------------------------------------------------------------+----------------------------------------+-------------+
+| Converter                           | Supported notations                                             | Supported Quantities                   | Vectorized  |
++=====================================+=================================================================+========================================+=============+
+| mechkit.notation.Converter          | tensor, mandel6, mandel9                                        | stress, strain, stiffness, compliance  | no          |
++-------------------------------------+-----------------------------------------------------------------+----------------------------------------+-------------+
+| mechkit.notation.ExplicitConverter  | tensor, mandel6, mandel9, voigt, umat, vumat, (abaqusMatAniso)  | stress, strain, stiffness, compliance  | yes         |
++-------------------------------------+-----------------------------------------------------------------+----------------------------------------+-------------+
+
+--------------------------------------------------------
+
 .. autoclass:: mechkit.notation.Converter
     :members:
     :undoc-members:
diff --git a/docs/source/operators.rst b/docs/source/operators.rst
index 25c0c7a..c218125 100644
--- a/docs/source/operators.rst
+++ b/docs/source/operators.rst
@@ -1,6 +1,20 @@
 operators
 ---------
 
+
++-------------------------------------------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
+| Operator                                                    | Supported tensor orders  | Vectorized  | Example configuration                                                                                               |
++=============================================================+==========================+=============+=====================================================================================================================+
+| mechkit.operators.Sym(axes).__call__                        | any                      | no          | axes=[0,1] symmetrizes the first two axes                                                                           |
++-------------------------------------------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
+| mechkit.operators.Sym_Fourth_Order_Special(label).__call__  | 4                        | no          | label="major" takes the major symmetric part, supported labels are ["left", "right", "major", "inner", "complete"]  |
++-------------------------------------------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
+| mechkit.operators.dev                                       | 2, 4                     | no          | none                                                                                                                |
++-------------------------------------------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
+
+
+--------------------------------------------------------
+
 .. automodule:: mechkit.operators
     :members:
     :undoc-members:
diff --git a/paper/paper.bib b/paper/paper.bib
index 274fa71..4f38d01 100644
--- a/paper/paper.bib
+++ b/paper/paper.bib
@@ -215,3 +215,19 @@ @software{quadpy
 year         = 2022,
 }
 
+@article{tensorly,
+  title={Tensorly: Tensor learning in python},
+  author={Kossaifi, Jean and Panagakis, Yannis and Anandkumar, Anima and Pantic, Maja},
+  journal={arXiv preprint arXiv:1610.09555},
+  year={2016}
+}
+
+@article{tenpy,
+  title={Efficient numerical simulations with tensor networks: Tensor Network Python (TeNPy)},
+  author={Hauschild, Johannes and Pollmann, Frank},
+  journal={SciPost Physics Lecture Notes},
+  pages={005},
+  year={2018}
+}
+
+
diff --git a/paper/paper.md b/paper/paper.md
index b0e960c..77785c8 100644
--- a/paper/paper.md
+++ b/paper/paper.md
@@ -79,6 +79,9 @@ To the best knowledge of the authors, there is no common library for the mathema
 This presents an obstacle with regard to the exchange and the reliability of research code and
 leads to negative consequences for the interpretation and comparison of results.
 
+Several multi-purpose tensor packages in Python, e.g., [@tensorly], [@tenpy], exist but mainly address the manipulation of multi-dimensional matrices which are not related to physical bases.
+In contrast, `mechkit` focuses on linear elasticity and provides a limited scope of notations for second- and fourth-order tensors.
+
 The main goal of `mechkit` is to provide reusable research code that increases the reliability of results.
 It is intended to accelerate and simplify further research.
 `mechkit` is inspired by [@fiberoripy], [@meshio], [@pygalmesh] and [@quadpy].


Test patch:
diff --git a/test/README.md b/test/README.md
index 21a6715..57b96a9 100644
--- a/test/README.md
+++ b/test/README.md
@@ -1,13 +1,14 @@
-# Run tests against installation (recommended)
-- Install in development mode `python setup.py develop`
+## Run tests against installation (recommended)
+- Install mechkit in development mode `python setup.py develop`
+- Install pytest `pip install pytest`
 - Run tests `pytest`
 - Uninstall `python setup.py develop --uninstall`
 
-# Run tests against local files
-`python -m pytest`  
+## Run tests against local files
+- Install mechkit and pytest (see steps above)
+- Run tests with `python -m pytest`  
 
-# Run specific tests
-[source](https://stackoverflow.com/a/62804929/8935243)
+## Run [specific](https://stackoverflow.com/a/62804929/8935243) tests
 
 Example from within ipython
 ```python