Skip to content
Snippets Groups Projects
Commit 39713829 authored by Colbry, Dirk's avatar Colbry, Dirk
Browse files

adding updates to instructions

parent d9b3d1ed
No related branches found
No related tags found
No related merge requests found
...@@ -2,91 +2,3 @@ ...@@ -2,91 +2,3 @@
Self guided curriculum to prepare students to start a Masters Degree in Data Science. Self guided curriculum to prepare students to start a Masters Degree in Data Science.
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.msu.edu/CMSE/data_science_bridge_curriculum.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.msu.edu/CMSE/data_science_bridge_curriculum/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
%% Cell type:code id:fc73d74c tags: %% Cell type:code id:fc73d74c tags:
``` python ``` python
##ANSWER## ##ANSWER##
#Install answercheck in current directory #Install answercheck in current directory
from urllib.request import urlretrieve from urllib.request import urlretrieve
urlretrieve('https://raw.githubusercontent.com/colbrydi/jupytercheck/master/answercheck.py', filename='answercheck.py') urlretrieve('https://raw.githubusercontent.com/colbrydi/jupytercheck/master/answercheck.py', filename='answercheck.py')
##ANSWER## ##ANSWER##
``` ```
%% Output %% Output
('answercheck.py', <http.client.HTTPMessage at 0x7fb0f93d4250>) ('answercheck.py', <http.client.HTTPMessage at 0x7fb0f93d4250>)
%% Cell type:markdown id:3c2a4f39 tags: %% Cell type:markdown id:3c2a4f39 tags:
# Short title # Short title
long title long title
%% Cell type:markdown id:2b78245b tags: %% Cell type:markdown id:2b78245b tags:
**_Optional_** Motivating picture: **_Optional_** Motivating picture:
![Antique picture of a bridge being built - Image found in the public domain](https://blogs.lse.ac.uk/impactofsocialsciences/files/2015/03/bridge-construction.jpg) ![Antique picture of a bridge being built - Image found in the public domain](https://blogs.lse.ac.uk/impactofsocialsciences/files/2015/03/bridge-construction.jpg)
%% Cell type:markdown id:71e867d9 tags: %% Cell type:markdown id:71e867d9 tags:
## Description ## Description
This a description of the topic. This a description of the topic.
## Learning Goals ## Learning Goals
Maybe we should include these as learning goals? Consider using [bloom's taxonomy](https://cft.vanderbilt.edu/guides-sub-pages/blooms-taxonomy/) Include learning goals for this notebook. Consider using [bloom's taxonomy](https://cft.vanderbilt.edu/guides-sub-pages/blooms-taxonomy/) and [bloom's verbs](https://tips.uark.edu/blooms-taxonomy-verb-chart/) to help focus the learning goals. Use a bullet for each learning goal and highlight the bloom verb using bold and underline. For example: After completing this notebook students should be able to:
%% Cell type:markdown id:2a07e824 tags: * **_Use_** a jupyter template to make their own curriculum.
* **_Evaluate_** a jupyter notebook's accessibility using standard methods.
* **_Construct_** a notebook using both markdown and python code.
* **_Write_** assessments based on learning goals.
* **_Implement_** interactive assessments using the ```answercheck``` library
##ANSWER##
TODO: Put a table here
##ANSWER##
%% Cell type:markdown id:58ec20e8 tags: %% Cell type:markdown id:58ec20e8 tags:
## Self Assessment ## Self Assessment
Questions that test for the learning goals and allows students to evaluate if they truly understand the topics. Questions that test for the learning goals and allows students to evaluate if they truly understand the topics.
%% Cell type:markdown id:5d237ca9 tags: %% Cell type:markdown id:5d237ca9 tags:
## Training Materials ## Training Materials
%% Cell type:markdown id:21f9b14e tags: %% Cell type:markdown id:21f9b14e tags:
[Direct Link to Video](https://www.youtube.com/watch?v=kzI-mPSY8y4) [Direct Link to Video](https://www.youtube.com/watch?v=kzI-mPSY8y4)
%% Cell type:code id:deeec8f7 tags: %% Cell type:code id:deeec8f7 tags:
``` python ``` python
from IPython.display import YouTubeVideo from IPython.display import YouTubeVideo
YouTubeVideo("kzI-mPSY8y4",width="100%", height=360, cc_load_policy=True) YouTubeVideo("kzI-mPSY8y4",width="100%", height=360, cc_load_policy=True)
``` ```
%% Output %% Output
<IPython.lib.display.YouTubeVideo at 0x7fb0cc25a6d0> <IPython.lib.display.YouTubeVideo at 0x7fb0cc25a6d0>
%% Cell type:markdown id:1b047470 tags: %% Cell type:markdown id:1b047470 tags:
&#9989; **<span style="color:red">Question:</span>** Example Multiple choice question: &#9989; **<span style="color:red">Question:</span>** Example Multiple choice question:
1. Answer 1 1. Answer 1
2. Answer b 2. Answer b
3. Answer III 3. Answer III
4. All of the above 4. All of the above
%% Cell type:code id:ee42a54e tags: %% Cell type:code id:ee42a54e tags:
``` python ``` python
##ANSWER## ##ANSWER##
3 3
##ANSWER## ##ANSWER##
``` ```
%% Output %% Output
3 3
%% Cell type:markdown id:dd9c7fa5 tags: %% Cell type:markdown id:dd9c7fa5 tags:
&#9989; **<span style="color:red">Question:</span>** Example answercheck question: What is $x = 2+2$? &#9989; **<span style="color:red">Question:</span>** Example answercheck question: What is $x = 2+2$?
%% Cell type:code id:64684dfd tags: %% Cell type:code id:64684dfd tags:
``` python ``` python
#Put your answer here #Put your answer here
``` ```
%% Cell type:code id:619a2259 tags: %% Cell type:code id:619a2259 tags:
``` python ``` python
##ANSWER## ##ANSWER##
x = 4 x = 4
##ANSWER## ##ANSWER##
``` ```
%% Cell type:code id:9cc2b34a tags: %% Cell type:code id:9cc2b34a tags:
``` python ``` python
from answercheck import checkanswer from answercheck import checkanswer
checkanswer.vector(x,'2cab95d1b144d663bad1ce5c51020ae0') checkanswer.vector(x,'2cab95d1b144d663bad1ce5c51020ae0')
``` ```
%% Output %% Output
CheckWarning: passed variable is <class 'int'> and not a numpy.matrix. CheckWarning: passed variable is <class 'int'> and not a numpy.matrix.
Trying to convert to a array matrix using ```A = np.matrix(A)```. Trying to convert to a array matrix using ```A = np.matrix(A)```.
CheckWarning: passed matrix is int64 and not <class 'numpy.float64'>... CheckWarning: passed matrix is int64 and not <class 'numpy.float64'>...
Trying to convert to float using ```A = A.astype(float)```. Trying to convert to float using ```A = A.astype(float)```.
Testing [[4.]] Testing [[4.]]
Answer seems to be correct Answer seems to be correct
%% Cell type:code id:8be3295e tags: %% Cell type:code id:8be3295e tags:
``` python ``` python
assert(True==True) assert(True==True)
``` ```
%% Cell type:markdown id:44b461a0 tags: %% Cell type:markdown id:44b461a0 tags:
--- ---
Written by <<YOUR NAME HERE>>, Michigan State University Written by <<YOUR NAME HERE>>, Michigan State University
As part of the Data Science Bridge Project As part of the Data Science Bridge Project
<a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>. <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment