Skip to content

release #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2022, Imperial College London
Copyright 2023, Imperial College London

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ $ jupyter notebook &

## Testing

After (almost) each exercise, there are two cells containing some code. In those cells, we test your solution using two different testing packages:
After (almost) each exercise, there are two cells containing some code. In those cells, we test your solution using two different methods:

1. **PyBryt** analyses your solution and provides you feedback on what is correct in your implementation, as well as what might be wrong. Please read PyBryt's feedback carefully and address the `ERROR` messages by modifying your solution.
2. **okpy** validates your final solution and provides you a mark for it.
2. **assert** statements validate your final solution

It is important to follow the instructions for each exercise exactly and do not change the names of variables, functions, or classes so that tests can analyse your code. Besides, please do not change the content of any of the testing cells.

Although **PyBryt** provides much more detailed feedback, it is possible it complains about your code even though **okpy** confirms your code is correct. This is because PyBryt testing is based on comparing your solution to reference solutions. Since there is virtually an infinite number of alternative solutions, it is possible that your solution is not in our references. On the other hand, **okpy** looks at the final result of your code and if **okpy** is happy with your result, your code is correct and you do not have to address **PyBryt**'s error messages (if any).
Although **PyBryt** provides much more detailed feedback, it is possible it complains about your code even though **assert** statement confirms your code is correct. This is because PyBryt testing is based on comparing your solution to reference solutions. Since there is virtually an infinite number of alternative solutions, it is possible that your solution is not in our references. On the other hand, assert statements check the final result of your code and if they do not raise an error, your code is correct and you do not have to address **PyBryt**'s error messages (if any).

## Support

Expand Down
5 changes: 3 additions & 2 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ channels:

dependencies:
- pip
- python=3.9 # Python 3.10 expected to work as well, but we are being conservative here.
- python=3.10
- pip:
- jupyterlab
- numpy
- matplotlib
- pendulum
- okpy
- pybryt>=0.7.0
- pybryt>=0.7.0
- pytest
6 changes: 3 additions & 3 deletions index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@
"\n",
"## Testing\n",
"\n",
"After (almost) each exercise, there are two cells containing some code. In those cells, we test your solution using two different testing packages:\n",
"After (almost) each exercise, there are two cells containing some code. In those cells, we test your solution using two different methods:\n",
"\n",
"1. **PyBryt** analyses your solution and provides you feedback on what is correct in your implementation, as well as what might be wrong. Please read PyBryt's feedback carefully and address the `ERROR` messages by modifying your solution.\n",
"2. **okpy** validates your final solution and provides you a mark for it.\n",
"2. **assert** statements validate your final solution\n",
"\n",
"It is important to follow the instructions for each exercise exactly and do not change the names of variables, functions, or classes so that tests can analyse your code. Besides, please do not change the content of any of the testing cells.\n",
"\n",
"Although **PyBryt** provides much more detailed feedback, it is possible it complains about your code even though **okpy** confirms your code is correct. This is because PyBryt testing is based on comparing your solution to reference solutions. Since there is virtually an infinite number of alternative solutions, it is possible that your solution is not in our references. On the other hand, **okpy** looks at the final result of your code and if **okpy** is happy with your result, your code is correct and you do not have to address **PyBryt**'s error messages (if any).\n",
"Although **PyBryt** provides much more detailed feedback, it is possible it complains about your code even though **assert** statement confirms your code is correct. This is because PyBryt testing is based on comparing your solution to reference solutions. Since there is virtually an infinite number of alternative solutions, it is possible that your solution is not in our references. On the other hand, assert statements check the final result of your code and if they do not raise an error, your code is correct and you do not have to address **PyBryt**'s error messages (if any).\n",
"\n",
"## Support\n",
"\n",
Expand Down
6 changes: 0 additions & 6 deletions lecture1/lecture.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
import pybryt
import pathlib
from client.api.notebook import Notebook
from client.api import assignment

# OkPy settings
args = assignment.Settings(server="clewolffautook21.eastus.cloudapp.azure.com/okpy")
ok = Notebook("./lecture.ok", args)


def pybryt_reference(lecture, exercise):
Expand Down
Loading