Skip to content

Commit

Permalink
pybamm-team#99 minor changes to infrastructure files
Browse files Browse the repository at this point in the history
  • Loading branch information
valentinsulzer committed Jan 25, 2019
1 parent 7f6f7d5 commit b64e191
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ $ python run-tests.py --books
If notebooks fail because of changes to pybamm, it can be a bit of a hassle to debug. In these cases, you can create a temporary export of a notebook's Python content using

```
$ python run-tests.py --debook examples/notebook-name.ipynb script.py
$ python run-tests.py --debook examples/notebooks/notebook-name.ipynb script.py
```


Expand Down Expand Up @@ -225,9 +225,9 @@ Next, open a browser, and navigate to your local PyBaMM directory (by typing the

### Example notebooks

Major PyBaMM features are showcased in [Jupyter notebooks](https://jupyter.org/) stored in the [examples directory](examples). Which features are "major" is of course wholly subjective, so please discuss on GitHub first!
Major PyBaMM features are showcased in [Jupyter notebooks](https://jupyter.org/) stored in the [examples directory](examples/notebooks). Which features are "major" is of course wholly subjective, so please discuss on GitHub first!

All example notebooks should be listed in [examples/README.md](https://github.com/tinosulzer/pybamm/examples/README.md). Please follow the (naming and writing) style of existing notebooks where possible.
All example notebooks should be listed in [examples/README.md](https://github.com/tinosulzer/pybamm/examples/notebooks/README.md). Please follow the (naming and writing) style of existing notebooks where possible.

Where possible, notebooks are tested daily. A list of slow notebooks (which time-out and fail tests) is maintained in `.slow-books`, these notebooks will be excluded from daily testing.

Expand Down
8 changes: 8 additions & 0 deletions run-tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,10 @@ def export_notebook(ipath, opath):
help="Export a Jupyter notebook to a Python file for manual testing.",
)
# Doctests
parser.add_argument(
"--flake8", action="store_true", help="Run flake8 to check for style issues"
)
# Doctests
parser.add_argument(
"--doctest",
action="store_true",
Expand Down Expand Up @@ -308,6 +312,10 @@ def export_notebook(ipath, opath):
if args.nosub:
has_run = True
run_unit_tests()
# Flake8
if args.flake8:
has_run = True
run_flake8()
# Doctests
if args.doctest:
has_run = True
Expand Down

0 comments on commit b64e191

Please sign in to comment.