Merge pull request #2542 from agriyakhetarpal/2347-remove-tutorials

Remove tutorials from readthedocs

Author: valentinsulzer

CONTRIBUTING.md

@@ -85,7 +85,7 @@ We use [black](https://black.readthedocs.io/en/stable/) to automatically configu
 black {source_file_or_directory}
 ```
 
-2. Editor: black can be [configured](https://test-black.readthedocs.io/en/latest/editor_integration.html) to automatically reformat a python script each time the script is saved in an editor.
+2. Editor: black can be [configured](https://test-black.readthedocs.io/en/latest/editor_integration.html) to automatically reformat a Python script each time the script is saved in an editor.
 
 If you want to use black in your editor, you may need to change the max line length in your editor settings.
 
@@ -214,7 +214,7 @@ This also means that, if you can't fix the bug yourself, it will be much easier
 
    or by just commenting out all the tests you don't want to run.
 
-2. Set break points, either in your IDE or using the python debugging module. To use the latter, add the following line where you want to set the break point
+2. Set break points, either in your IDE or using the Python debugging module. To use the latter, add the following line where you want to set the break point
 
    ```python
    import ipdb; ipdb.set_trace()
@@ -257,7 +257,7 @@ This also means that, if you can't fix the bug yourself, it will be much easier
 
       You can then step through the expression tree, using the `children` attribute, to pinpoint exactly where a bug is coming from. For example, if `expression_tree.jac(y)` is failing, you can check `expression_tree.children[0].jac(y)`, then `expression_tree.children[0].children[0].jac(y)`, etc.
 
-3. To isolate whether a bug is in a model, its jacobian or its simplified version, you can set the `use_jacobian` and/or `use_simplify` attributes of the model to `False` (they are both `True` by default for most models).
+3. To isolate whether a bug is in a model, its Jacobian or its simplified version, you can set the `use_jacobian` and/or `use_simplify` attributes of the model to `False` (they are both `True` by default for most models).
 4. If a model isn't giving the answer you expect, you can try comparing it to other models. For example, you can investigate parameter limits in which two models should give the same answer by setting some parameters to be small or zero. The `StandardOutputComparison` class can be used to compare some standard outputs from battery models.
 5. To get more information about what is going on under the hood, and hence understand what is causing the bug, you can set the [logging](https://realpython.com/python-logging/) level to `DEBUG` by adding the following line to your test or script:
 
@@ -340,9 +340,9 @@ Adding the command
 pybamm.print_citations()
 ```
 
-to the end of a script will print all citations that were used by that script. This will print bibtex information to the terminal; passing a filename to `print_citations` will print the bibtex information to the specified file instead.
+to the end of a script will print all citations that were used by that script. This will print BibTeX information to the terminal; passing a filename to `print_citations` will print the BibTeX information to the specified file instead.
 
-When you contribute code to PyBaMM, you can add your own papers that you would like to be cited if that code is used. First, add the bibtex for your paper to [CITATIONS.txt](pybamm/CITATIONS.txt). Then, add the line
+When you contribute code to PyBaMM, you can add your own papers that you would like to be cited if that code is used. First, add the BibTeX for your paper to [CITATIONS.txt](pybamm/CITATIONS.txt). Then, add the line
 
 ```python3
 pybamm.citations.register("your_paper_bibtex_identifier")
@@ -368,7 +368,7 @@ Note that this file must be kept in sync with the version number in [pybamm/**in
 
 Each change pushed to the PyBaMM GitHub repository will trigger the test and benchmark suites to be run, using [GitHub actions](https://github.com/features/actions).
 
-Tests are run for different operating systems, and for all python versions officially supported by PyBaMM. If you opened a Pull Request, feedback is directly available on the corresponding page. If all tests pass, a green tick will be displayed next to the corresponding test run. If one or more test(s) fail, a red cross will be displayed instead.
+Tests are run for different operating systems, and for all Python versions officially supported by PyBaMM. If you opened a Pull Request, feedback is directly available on the corresponding page. If all tests pass, a green tick will be displayed next to the corresponding test run. If one or more test(s) fail, a red cross will be displayed instead.
 
 Similarly, the benchmark suite is automatically run for the most recently pushed commit. Benchmark results are compared to the results available for the latest commit on the `develop` branch. Should any significant performance regression be found, a red cross will be displayed next to the benchmark run.
 

README.md

@@ -111,7 +111,7 @@ If you use PyBaMM in your work, please cite our paper
 
 > Sulzer, V., Marquis, S. G., Timms, R., Robinson, M., & Chapman, S. J. (2021). Python Battery Mathematical Modelling (PyBaMM). _Journal of Open Research Software, 9(1)_.
 
-You can use the bibtex
+You can use the BibTeX
 
 ```
 @article{Sulzer2021,
@@ -133,7 +133,7 @@ We would be grateful if you could also cite the relevant papers. These will chan
 pybamm.print_citations()
 ```
 
-to the end of your script. This will print bibtex information to the terminal; passing a filename to `print_citations` will print the bibtex information to the specified file instead. A list of all citations can also be found in the [citations file](https://github.com/pybamm-team/PyBaMM/blob/develop/pybamm/CITATIONS.txt). In particular, PyBaMM relies heavily on [CasADi](https://web.casadi.org/publications/).
+to the end of your script. This will print BibTeX information to the terminal; passing a filename to `print_citations` will print the BibTeX information to the specified file instead. A list of all citations can also be found in the [citations file](https://github.com/pybamm-team/PyBaMM/blob/develop/pybamm/CITATIONS.txt). In particular, PyBaMM relies heavily on [CasADi](https://web.casadi.org/publications/).
 See [CONTRIBUTING.md](https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md#citations) for information on how to add your own citations when you contribute.
 
 ## 🛠️ Contributing to PyBaMM

docs/index.rst

@@ -96,13 +96,6 @@ and run locally using ``jupyter notebook``, or online through
 Contributing
 ============
 
-There are many ways to contribute to PyBaMM:
-
-.. toctree::
-    :maxdepth: 1
-
-    tutorials/add-model
-    tutorials/add-spatial-method
-    tutorials/add-solver
+Contributions to PyBaMM and its development are welcome! If you have ideas for features, bug fixes, models, spatial methods, or solvers, we would love to hear from you.
 
 Before contributing, please read the `Contribution Guidelines <https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md>`_.

docs/install/GNU-linux.rst

@@ -28,7 +28,7 @@ brew <https://docs.python-guide.org/starting/install3/osx/>`__:
 
 .. code:: bash
 
-   ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+   ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 
 then follow instructions in link on adding brew to path, and run
 
@@ -45,8 +45,8 @@ User install
 ------------
 
 We recommend to install PyBaMM within a virtual environment, in order
-not to alter any distribution python files.
-First, make sure you are using python 3.8 or 3.9.
+not to alter any distribution Python files.
+First, make sure you are using Python 3.8 or 3.9.
 To create a virtual environment ``env`` within your current directory type:
 
 .. code:: bash
@@ -161,7 +161,7 @@ repository
    git clone https://github.com/pybamm-team/PyBaMM.git
    cd PyBaMM
 
-Then, to install PyBaMM as a `developer <CONTRIBUTING.md>`__, type
+Then, to install PyBaMM as a `developer <https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md>`__, type
 
  .. code:: bash
 
@@ -174,7 +174,7 @@ To check whether PyBaMM has installed properly, you can run the tests:
    python3 run-tests.py --unit
 
 Before you start contributing to PyBaMM, please read the `contributing
-guidelines <CONTRIBUTING.md>`__.
+guidelines <https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md>`__.
 
 Uninstall PyBaMM
 ================

docs/install/install-from-source.rst

@@ -5,7 +5,7 @@ Install from source (developer install)
 
 This page describes the build and installation of PyBaMM from the source code, available on GitHub. Note that this is **not the recommended approach for most users** and should be reserved to people wanting to participate in the development of PyBaMM, or people who really need to use bleeding-edge feature(s) not yet available in the latest released version. If you do not fall in the two previous categories, you would be better off installing PyBaMM using pip or conda.
 
-Lastly, familiarity with the python ecosystem is recommended (pip, virtualenvs).
+Lastly, familiarity with the Python ecosystem is recommended (pip, virtualenvs).
 Here is a gentle introduction/refresher: `Python Virtual Environments: A Primer <https://realpython.com/python-virtual-environments-a-primer/>`_.
 
 
@@ -26,7 +26,7 @@ or download the source archive on the repository's homepage.
 To install PyBaMM, you will need:
 
 - Python 3 (PyBaMM supports versions 3.8 and 3.9)
-- The python headers file for your current python version.
+- The Python headers file for your current Python version.
 - A BLAS library (for instance `openblas <https://www.openblas.net/>`_).
 - A C compiler (ex: ``gcc``).
 - A Fortran compiler (ex: ``gfortran``).
@@ -52,7 +52,7 @@ You can install it with
 
 	  python3.X -m pip install --user "tox<4"
 
-Depending on your operating system, you may or may not have ``pip`` installed along python.
+Depending on your operating system, you may or may not have ``pip`` installed along Python.
 If ``pip`` is not found, you probably want to install the ``python3-pip`` package.
 
 Installing the build-time requirements
@@ -105,7 +105,7 @@ If you'd rather do things yourself,
 4. Clone the pybind11 repository in the ``PyBaMM/`` directory (make sure the directory is named ``pybind11``).
 
 
-PyBaMM ships with a python script that automates points 2. and 3. You can run it with
+PyBaMM ships with a Python script that automates points 2. and 3. You can run it with
 
 .. code:: bash
 
@@ -198,7 +198,7 @@ You can run unit tests for PyBaMM using
 
 
 The above starts a sub-process using the current python interpreter (i.e. using your current
-python environment) and run the unit tests. This can take a few minutes.
+Python environment) and run the unit tests. This can take a few minutes.
 
 You can also use the test runner to run the doctests:
 

docs/install/windows-wsl.rst

@@ -64,7 +64,7 @@ Use Visual Studio Code to run PyBaMM
 
 You will probably want to use a native Windows IDE such as Visual Studio
 Code or the full Microsoft Visual Studio IDE. Both of these packages can
-connect to WSL so that you can write python code in a native windows
+connect to WSL so that you can write Python code in a native windows
 environment, while at the same time using WSL to run the code using your
 installed Ubuntu distribution. The following instructions assume that
 you are using Visual Studio Code.