added info about sec_cutoff to the documentation

.codeclimate.yml

@@ -1,46 +1,46 @@
-version: "2"
-exclude_patterns:
-- "doc/"
-- "dist/"
-- "**/tests/"
-checks:
-  argument-count:
-    config:
-      threshold: 10
-  complex-logic:
-    config:
-      threshold: 20
-  file-lines:
-    enabled: false
-  method-complexity:
-    config:
-      threshold: 20
-  method-count:
-    config:
-      threshold: 75
-  method-lines:
-    config:
-      threshold: 100
-  nested-control-flow:
-    config:
-      threshold: 4
-  return-statements:
-    config:
-      threshold: 4
-  similar-code:
-    config:
-      threshold: 64
-  identical-code:
-    config:
-      threshold: 64
-plugins:
-  fixme:
-    enabled: true
-  pep8:
-    enabled: true
-  duplication:
-    enabled: true
-    config:
-      languages:
-        python:
-          python_version: 3
+version: "2"
+exclude_patterns:
+- "doc/"
+- "dist/"
+- "**/tests/"
+checks:
+  argument-count:
+    config:
+      threshold: 10
+  complex-logic:
+    config:
+      threshold: 20
+  file-lines:
+    enabled: false
+  method-complexity:
+    config:
+      threshold: 20
+  method-count:
+    config:
+      threshold: 75
+  method-lines:
+    config:
+      threshold: 100
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: 64
+  identical-code:
+    config:
+      threshold: 64
+plugins:
+  fixme:
+    enabled: true
+  pep8:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        python:
+          python_version: 3

.coveragerc

@@ -1,10 +1,10 @@
-[run]
-source = qutip
-omit =
-    # QuTiP test files
-    */qutip/tests/*
-
-[report]
-exclude_lines =
-    # Skip Python wrappers which help load in C extension modules.
-    __bootstrap__()
+[run]
+source = qutip
+omit =
+    # QuTiP test files
+    */qutip/tests/*
+
+[report]
+exclude_lines =
+    # Skip Python wrappers which help load in C extension modules.
+    __bootstrap__()

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,53 +1,53 @@
-name: 🐛 Bug Report
-description: Spotted a bug? Report it to us!
-labels: ["bug"]
-body:
-  - type: textarea
-    id: bug-description
-    attributes:
-      label: Bug Description
-      description: Tell us what went wrong (including what triggered the bug)
-      placeholder: "A clear and concise description of what the bug is, and the steps to reproduce it"
-    validations:
-      required: true
-  - type: textarea
-    id: code-to-reproduce
-    attributes:
-      label: Code to Reproduce the Bug
-      description: Please provide a minimal working example. Paste your code directly (It will be automatically formatted, so there's no need for backticks)
-      placeholder: "from qutip import identity\nprint(identity(2))"
-      render: shell
-  - type: textarea
-    id: bug-output
-    attributes:
-      label: Code Output
-      description: Please paste the relevant output here (automatically formatted)
-      placeholder: "Quantum object: dims = [[2], [2]], shape = (2, 2), type = oper, isherm = True\nQobj data =\n[[1. 0.]\n[0. 1.]]"
-      render: shell
-  - type: textarea
-    id: expected-behaviour
-    attributes:
-      label: Expected Behaviour
-      description: What should have happened instead?
-      placeholder: "A clear and concise description of what you expected to happen"
-    validations:
-      required: true
-  - type: textarea
-    id: your-environment
-    attributes:
-      label: Your Environment
-      description: Please use `qutip.about()` to get the information about your environment and paste it here (automatically formatted)
-      placeholder: "QuTiP Version:      ***\nNumpy Version:      ***\nScipy Version:      ***\nCython Version:     ***\nMatplotlib Version: ***\nPython Version:     ***\nNumber of CPUs:     ***\nBLAS Info:          ***\nOPENMP Installed:   ***\nINTEL MKL Ext:      ***\nPlatform Info:      ***"
-      render: shell
-    validations:
-      required: true
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: Additional Context
-      description: Add anything else you want to tell us. You can include images, plots, etc.
-      placeholder: "Additional information, images, graphs, plots, etc."
-  - type: markdown
-    id: thank-you
-    attributes:
+name: 🐛 Bug Report
+description: Spotted a bug? Report it to us!
+labels: ["bug"]
+body:
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug Description
+      description: Tell us what went wrong (including what triggered the bug)
+      placeholder: "A clear and concise description of what the bug is, and the steps to reproduce it"
+    validations:
+      required: true
+  - type: textarea
+    id: code-to-reproduce
+    attributes:
+      label: Code to Reproduce the Bug
+      description: Please provide a minimal working example. Paste your code directly (It will be automatically formatted, so there's no need for backticks)
+      placeholder: "from qutip import identity\nprint(identity(2))"
+      render: shell
+  - type: textarea
+    id: bug-output
+    attributes:
+      label: Code Output
+      description: Please paste the relevant output here (automatically formatted)
+      placeholder: "Quantum object: dims = [[2], [2]], shape = (2, 2), type = oper, isherm = True\nQobj data =\n[[1. 0.]\n[0. 1.]]"
+      render: shell
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: Expected Behaviour
+      description: What should have happened instead?
+      placeholder: "A clear and concise description of what you expected to happen"
+    validations:
+      required: true
+  - type: textarea
+    id: your-environment
+    attributes:
+      label: Your Environment
+      description: Please use `qutip.about()` to get the information about your environment and paste it here (automatically formatted)
+      placeholder: "QuTiP Version:      ***\nNumpy Version:      ***\nScipy Version:      ***\nCython Version:     ***\nMatplotlib Version: ***\nPython Version:     ***\nNumber of CPUs:     ***\nBLAS Info:          ***\nOPENMP Installed:   ***\nINTEL MKL Ext:      ***\nPlatform Info:      ***"
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add anything else you want to tell us. You can include images, plots, etc.
+      placeholder: "Additional information, images, graphs, plots, etc."
+  - type: markdown
+    id: thank-you
+    attributes:
       value: Thanks for taking the time to fill out this bug report!

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,36 +1,36 @@
-name: 🚀 Feature Request
-description: Suggest an idea for this project!
-labels: ["ENH"]
-body:
-  - type: textarea
-    id: problem-description
-    attributes:
-      label: Problem Description
-      description: Give us a clear and concise description of what the problem is!
-      placeholder: "Example - It would be better if [...]"
-    validations:
-      required: true
-  - type: textarea
-    id: proposed-solution
-    attributes:
-      label: Proposed Solution
-      description: Give us a description of your proposed solution
-      placeholder: "A clear and concise description of what you want to happen"
-    validations:
-      required: true
-  - type: textarea
-    id: alternate-solutions
-    attributes:
-      label: Alternate Solutions
-      description: Are there other ways of implementing this feature?
-      placeholder: "A clear and concise description of any alternative solutions or features you've considered"
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: Additional Context
-      description: You can tell us more about your idea, add code snippets or images, etc.
-      placeholder: "Give us more context or screenshots about the feature request here"
-  - type: markdown
-    id: thank-you
-    attributes:
+name: 🚀 Feature Request
+description: Suggest an idea for this project!
+labels: ["ENH"]
+body:
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Problem Description
+      description: Give us a clear and concise description of what the problem is!
+      placeholder: "Example - It would be better if [...]"
+    validations:
+      required: true
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: Proposed Solution
+      description: Give us a description of your proposed solution
+      placeholder: "A clear and concise description of what you want to happen"
+    validations:
+      required: true
+  - type: textarea
+    id: alternate-solutions
+    attributes:
+      label: Alternate Solutions
+      description: Are there other ways of implementing this feature?
+      placeholder: "A clear and concise description of any alternative solutions or features you've considered"
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: You can tell us more about your idea, add code snippets or images, etc.
+      placeholder: "Give us more context or screenshots about the feature request here"
+  - type: markdown
+    id: thank-you
+    attributes:
       value: Thanks for taking the time to fill out this feature request!

.github/ISSUE_TEMPLATE/others.yaml

@@ -1,15 +1,15 @@
-name: 🤔 Others
-description: Tell us about issues that aren't exactly bugs or features
-body:
-  - type: textarea
-    id: issue-description
-    attributes:
-      label: Describe the Issue!
-      description: Tell us about your issue. You can include screenshots, code snippets, etc.
-      placeholder: "Please describe the issue here"
-    validations:
-      required: true
-  - type: markdown
-    id: thank-you
-    attributes:
+name: 🤔 Others
+description: Tell us about issues that aren't exactly bugs or features
+body:
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: Describe the Issue!
+      description: Tell us about your issue. You can include screenshots, code snippets, etc.
+      placeholder: "Please describe the issue here"
+    validations:
+      required: true
+  - type: markdown
+    id: thank-you
+    attributes:
       value: Thanks for taking the time to fill out this issue!

.github/pull_request_template.md

@@ -1,17 +1,17 @@
-**Checklist**
-Thank you for contributing to QuTiP! Please make sure you have finished the following tasks before opening the PR.
-
-- [ ] Please read [Contributing to QuTiP Development](http://qutip.org/docs/latest/development/contributing.html)
-- [ ] Contributions to qutip should follow the [pep8 style](https://www.python.org/dev/peps/pep-0008/).
-You can use [pycodestyle](http://pycodestyle.pycqa.org/en/latest/index.html) to check your code automatically
-- [ ] Please add tests to cover your changes if applicable.
-- [ ] If the behavior of the code has changed or new feature has been added, please also update the documentation in the `doc` folder, and the [notebook](https://github.com/qutip/qutip-tutorials). Feel free to ask if you are not sure.
-- [ ] Include the changelog in a file named: `doc/changes/<PR number>.<type>` 'type' can be one of the following: feature, bugfix, doc, removal, misc, or deprecation (see [here](http://qutip.org/docs/latest/development/contributing.html#changelog-generation) for more information).
-
-Delete this checklist after you have completed all the tasks. If you have not finished them all, you can also open a [Draft Pull Request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) to let the others know this on-going work and keep this checklist in the PR description.
-
-**Description**
-Describe here the proposed change.
-
-**Related issues or PRs**
+**Checklist**
+Thank you for contributing to QuTiP! Please make sure you have finished the following tasks before opening the PR.
+
+- [ ] Please read [Contributing to QuTiP Development](http://qutip.org/docs/latest/development/contributing.html)
+- [ ] Contributions to qutip should follow the [pep8 style](https://www.python.org/dev/peps/pep-0008/).
+You can use [pycodestyle](http://pycodestyle.pycqa.org/en/latest/index.html) to check your code automatically
+- [ ] Please add tests to cover your changes if applicable.
+- [ ] If the behavior of the code has changed or new feature has been added, please also update the documentation in the `doc` folder, and the [notebook](https://github.com/qutip/qutip-tutorials). Feel free to ask if you are not sure.
+- [ ] Include the changelog in a file named: `doc/changes/<PR number>.<type>` 'type' can be one of the following: feature, bugfix, doc, removal, misc, or deprecation (see [here](http://qutip.org/docs/latest/development/contributing.html#changelog-generation) for more information).
+
+Delete this checklist after you have completed all the tasks. If you have not finished them all, you can also open a [Draft Pull Request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) to let the others know this on-going work and keep this checklist in the PR description.
+
+**Description**
+Describe here the proposed change.
+
+**Related issues or PRs**
 Please mention the related issues or PRs here. If the PR fixes an issue, use the keyword fix/fixes/fixed followed by the issue id, e.g. fix #1184