File size: 3,779 Bytes
38ca196 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"#| hide\n",
"from wardbuddy.core import *"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# wardbuddy\n",
"\n",
"> Making placement learning fun and effective for medical students with a personalised AI system"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This file will become your README and also the index of your documentation."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Developer Guide"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"If you are new to using `nbdev` here are some useful pointers to get you started."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Install wardbuddy in Development mode"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```sh\n",
"# make sure wardbuddy package is installed in development mode\n",
"$ pip install -e .\n",
"\n",
"# make changes under nbs/ directory\n",
"# ...\n",
"\n",
"# compile to have changes apply to wardbuddy\n",
"$ nbdev_prepare\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Usage"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Installation"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Install latest from the GitHub [repository][repo]:\n",
"\n",
"```sh\n",
"$ pip install git+https://github.com/Dyadd/wardbuddy.git\n",
"```\n",
"\n",
"or from [conda][conda]\n",
"\n",
"```sh\n",
"$ conda install -c Dyadd wardbuddy\n",
"```\n",
"\n",
"or from [pypi][pypi]\n",
"\n",
"\n",
"```sh\n",
"$ pip install wardbuddy\n",
"```\n",
"\n",
"\n",
"[repo]: https://github.com/Dyadd/wardbuddy\n",
"[docs]: https://Dyadd.github.io/wardbuddy/\n",
"[pypi]: https://pypi.org/project/wardbuddy/\n",
"[conda]: https://anaconda.org/Dyadd/wardbuddy"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Documentation"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Documentation can be found hosted on this GitHub [repository][repo]'s [pages][docs]. Additionally you can find package manager specific guidelines on [conda][conda] and [pypi][pypi] respectively.\n",
"\n",
"[repo]: https://github.com/Dyadd/wardbuddy\n",
"[docs]: https://Dyadd.github.io/wardbuddy/\n",
"[pypi]: https://pypi.org/project/wardbuddy/\n",
"[conda]: https://anaconda.org/Dyadd/wardbuddy"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## How to use"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Fill me in please! Don't forget code examples:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"2"
]
},
"execution_count": null,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"1+1"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "python3",
"language": "python",
"name": "python3"
}
},
"nbformat": 4,
"nbformat_minor": 4
}
|