Metadata-Version: 2.1
Name: hdo_nbdev_template
Version: 0.0.1
Summary: project page
Home-page: https://github.com/hdocmsu/hdo_nbdev_template/
Author: Hung P. Do, PhD, MSEE
Author-email: clinicalcollaborations@gmail.com
License: None
Keywords: nbdev,mri,medical imaging,deep learning,magnetic resonance imaging
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Provides-Extra: dev

# README


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Get started

- Create a new project using this template

- run `make init_repository` to initialize the repo for nbdev

- run `nbdev_preview` to makesure nbdev renders the website

- modify `setting.ini` and `_quarto.yml` as needed to reflect names and
  hyperlinks of this project

- add notebook in the `nbs` folder and start building software

- `git add`, `git commit`, `git push` to save your work

## Deploy manually

- `make deploy_to_githubpage` to deploy the website to github pages

- from github, go to `Settings` -\> `Pages` to set the source of the
  github page to `main` branch and `/docs` folder and `save`

- visit the website at `https://<username>.github.io/<project_name>`

- in the future you can run `make deploy_to_githubpage` to update the
  website automatically

## Deploy automatically

- first, go to `Settings` -\> `Actions` -\> `general` -\>
  `Workflows Permissions` and enable `Read and write access` for
  `Actions` and `Workflows`

- from github, go to `Settings` -\> `Pages` to set the source of the
  github page to `github-pages` branch root folder and `save`

- with github action, the website will be automatically deployed to
  github pages when you push to the `main` branch

- visit the website at `https://<username>.github.io/<project_name>`

- in the future the website will be updated automatically via github
  action after every push to the `main` branch

## Local development and deployment

- `nbdev_preview` to preview the website locally

- `nbdev_export` to export the the library

- `pip install -e .` to install the library in editable mode

- `nbdev_pypi` to build the package and upload to pypi

## License

- add appropriate license to the project by modifying `LICENSE` file.
  Instructions can be found
  [here](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)

## Happy Coding!

``` python
1+1
```

    2

``` python
print("Hello World!")
```

    Hello World!
